Package pl.edu.icm.unity.engine.api.translation.in

Enum GroupEffectMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GroupEffectMode>
    public enum GroupEffectMode
extends java.lang.Enum<GroupEffectMode>
    Defines how a mapped group should be handled.
    Author:
    K. Benedyczak

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADD_IF_GROUP_EXISTS
      Identity will be added to the target group only if the group exists.
      CREATE_GROUP_IF_MISSING
      If a target group is missing then it will be created first, then the identity is added.
      REQUIRE_EXISTING_GROUP
      If the target group is missing translation will fail.

    • Method Summary

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

      • REQUIRE_EXISTING_GROUP

        public static final GroupEffectMode REQUIRE_EXISTING_GROUP
        If the target group is missing translation will fail.

      • ADD_IF_GROUP_EXISTS

        public static final GroupEffectMode ADD_IF_GROUP_EXISTS
        Identity will be added to the target group only if the group exists.

      • CREATE_GROUP_IF_MISSING

        public static final GroupEffectMode CREATE_GROUP_IF_MISSING
        If a target group is missing then it will be created first, then the identity is added.

    • Method Detail

      • values

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

      • valueOf

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