Enum Cardinality

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Cardinality>

    public enum Cardinality
    extends java.lang.Enum<Cardinality>
    For use in the creation of custom bundle annotations wishing to control the cardinality of generated requirements.

    The Enum.name will automatically be converted to lower case during macro processing.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      Default element value for annotation.
      MULTIPLE
      Indicates if the requirement can be wired multiple times.
      SINGLE
      Indicates if the requirement can only be wired a single time.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static Cardinality valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Cardinality[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • SINGLE

        public static final Cardinality SINGLE
        Indicates if the requirement can only be wired a single time.
      • MULTIPLE

        public static final Cardinality MULTIPLE
        Indicates if the requirement can be wired multiple times.
      • DEFAULT

        public static final Cardinality DEFAULT
        Default element value for annotation. This is used to distinguish the default value for an element and should not otherwise be used.
    • Method Detail

      • values

        public static Cardinality[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Cardinality c : Cardinality.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Cardinality valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Cardinality>