Class CExceptionDescriptor

    • Constructor Summary

      Constructors 
      Constructor Description
      CExceptionDescriptor​(java.lang.String comment, java.lang.String packageName, java.lang.String name, java.util.List<CField<CException>> fields, java.util.Map<java.lang.String,​java.lang.String> annotations)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CField<CException> findFieldById​(int id)  
      CField<CException> findFieldByName​(java.lang.String name)  
      java.util.Set<java.lang.String> getAnnotations()
      Get set of available annotations.
      java.lang.String getAnnotationValue​(java.lang.String name)
      Get the given annotation value.
      java.lang.String getDocumentation()
      The type comment is the last block of comment written before the type declaration.
      CField<CException>[] getFields()  
      CInterfaceDescriptor getImplementing()  
      boolean hasAnnotation​(java.lang.String name)
      Get the given annotation value.
      boolean isSimple()  
      • Methods inherited from class net.morimekta.providence.descriptor.PExceptionDescriptor

        getVariant
      • Methods inherited from class net.morimekta.providence.descriptor.PMessageDescriptor

        builder, equals, fieldForId, fieldForName, getBuilderSupplier, getType, hashCode
      • Methods inherited from class net.morimekta.providence.descriptor.PDeclaredDescriptor

        getDefaultValue, getName, getProgramName, getQualifiedName, toString
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface net.morimekta.providence.descriptor.PDescriptor

        getDefaultValue, getName, getProgramName, getQualifiedName, getQualifiedName, getType
    • Constructor Detail

      • CExceptionDescriptor

        public CExceptionDescriptor​(java.lang.String comment,
                                    java.lang.String packageName,
                                    java.lang.String name,
                                    java.util.List<CField<CException>> fields,
                                    java.util.Map<java.lang.String,​java.lang.String> annotations)
    • Method Detail

      • getDocumentation

        public final java.lang.String getDocumentation()
        Description copied from interface: CAnnotatedDescriptor
        The type comment is the last block of comment written before the type declaration. Comments on the same line, after the declaration is ignored.
        Specified by:
        getDocumentation in interface CAnnotatedDescriptor
        Returns:
        The comment string containing all formatting (not including the comment delimiter and the leading space.
      • hasAnnotation

        public boolean hasAnnotation​(@Nonnull
                                     java.lang.String name)
        Description copied from interface: CAnnotatedDescriptor
        Get the given annotation value.
        Specified by:
        hasAnnotation in interface CAnnotatedDescriptor
        Parameters:
        name - Name of annotation.
        Returns:
        If the annotation is present.
      • getAnnotationValue

        public java.lang.String getAnnotationValue​(@Nonnull
                                                   java.lang.String name)
        Description copied from interface: CAnnotatedDescriptor
        Get the given annotation value.
        Specified by:
        getAnnotationValue in interface CAnnotatedDescriptor
        Parameters:
        name - Name of annotation.
        Returns:
        The annotation value or null.
      • isSimple

        public boolean isSimple()
        Specified by:
        isSimple in interface CMessageDescriptor
        Overrides:
        isSimple in class net.morimekta.providence.descriptor.PMessageDescriptor<CException>
        Returns:
        True if the message is simple. A simple message contains no containers, and no sub-messages.