Package lumis.portal.propertybag

Enum PropertyInheritMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PropertyInheritMode>
    @StableMinor(version="17.0",
             sinceVersion="7.0")
public enum PropertyInheritMode
extends java.lang.Enum<PropertyInheritMode>
    Indicates the mode the values of a property is inherited to a property bag from its parent property bag.
    Since:
    7.0.0
    Version:
    $Revision$ $Date$

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      APPEND
      Append the values inherited from the parent property bag.
      IGNORE
      Ignore the values that would be inherited from the parent property bag.
      PREPEND
      Prepend the values inherited from the parent property bag.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PropertyInheritMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PropertyInheritMode[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • IGNORE

        public static final PropertyInheritMode IGNORE
        Ignore the values that would be inherited from the parent property bag. So the property actually will not inherit any value.

        Note that parent values are only ignored if a value is set locally. Otherwise the parent value is used directly.

        Example: if property has local values [L1, L2, L3] and parent has values [P1, P2, P3], then the property values will be [L1, L2, L3].

        Since:
        7.0.0

      • PREPEND

        public static final PropertyInheritMode PREPEND
        Prepend the values inherited from the parent property bag. So the property values will begin with the values from its parent, followed by the values specified locally.

        Example: if property has local values [L1, L2, L3] and parent has values [P1, P2, P3], then the property values will be [P1, P2, P3, L1, L2, L3].

        Since:
        7.0.0

      • APPEND

        public static final PropertyInheritMode APPEND
        Append the values inherited from the parent property bag. So the property values will begin with the values specified locally followed by the values from its parent.

        Example: if property has local values [L1, L2, L3] and parent has values [P1, P2, P3], then the property values will be [L1, L2, L3, P1, P2, P3].

        Since:
        7.0.0

    • Method Detail

      • values

        public static PropertyInheritMode[] 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 (PropertyInheritMode c : PropertyInheritMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PropertyInheritMode 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