Class CEnumDescriptor

    • Field Summary

      • Fields inherited from class net.morimekta.providence.descriptor.PEnumDescriptor

        DEFAULT_FIRST_VALUE
    • Constructor Summary

      Constructors 
      Constructor Description
      CEnumDescriptor​(java.lang.String comment, java.lang.String packageName, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> annotations)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CEnumValue findById​(int id)  
      CEnumValue findByName​(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.
      CEnumValue[] getValues()  
      boolean hasAnnotation​(java.lang.String name)
      Get the given annotation value.
      void setValues​(java.util.List<CEnumValue> values)  
      • Methods inherited from class java.lang.Object

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

        getDefaultValue, getName, getProgramName, getQualifiedName
      • Methods inherited from interface net.morimekta.providence.descriptor.PDescriptor

        getQualifiedName
      • Methods inherited from class net.morimekta.providence.descriptor.PEnumDescriptor

        builder, equals, getBuilderSupplier, getType, hashCode, toString, valueForId, valueForName
    • Constructor Detail

      • CEnumDescriptor

        public CEnumDescriptor​(@Nullable
                               java.lang.String comment,
                               @Nonnull
                               java.lang.String packageName,
                               @Nonnull
                               java.lang.String name,
                               @Nullable
                               java.util.Map<java.lang.String,java.lang.String> annotations)
    • Method Detail

      • setValues

        public void setValues​(@Nonnull
                              java.util.List<CEnumValue> values)
      • 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.
      • getValues

        @Nonnull
        public CEnumValue[] getValues()
        Specified by:
        getValues in class net.morimekta.providence.descriptor.PEnumDescriptor<CEnumValue>
      • findById

        @Nullable
        public CEnumValue findById​(int id)
        Specified by:
        findById in class net.morimekta.providence.descriptor.PEnumDescriptor<CEnumValue>
      • findByName

        @Nullable
        public CEnumValue findByName​(java.lang.String name)
        Specified by:
        findByName in class net.morimekta.providence.descriptor.PEnumDescriptor<CEnumValue>
      • 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.