com.ibm.jarm.api.constants

Enum RMPrincipalSearchType

  • java.lang.Object
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      Contains
      Indicates that the pattern string must be contained in the search scope.
      Custom
      The caller can pass in a pattern string acceptable by the underlying directory service in use.
      Exact
      Indicates that the pattern string represents an exact match requirement.
      None
      No pattern matching is used.
      PrefixMatch
      Indicates that the pattern string represents a prefix to match against.
      SuffixMatch
      Indicates that the pattern string represents a suffix to match against.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static RMPrincipalSearchType getInstanceFromInt(int intValue)
      Provides the RMPrincipalSearchType instance that corresponds to the given int value.
      int getIntValue()
      Returns the integer value associated with this member.
      static RMPrincipalSearchType valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RMPrincipalSearchType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

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

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

      • Custom

        public static final RMPrincipalSearchType Custom
        The caller can pass in a pattern string acceptable by the underlying directory service in use.
      • PrefixMatch

        public static final RMPrincipalSearchType PrefixMatch
        Indicates that the pattern string represents a prefix to match against.
      • SuffixMatch

        public static final RMPrincipalSearchType SuffixMatch
        Indicates that the pattern string represents a suffix to match against.
      • Contains

        public static final RMPrincipalSearchType Contains
        Indicates that the pattern string must be contained in the search scope.
      • Exact

        public static final RMPrincipalSearchType Exact
        Indicates that the pattern string represents an exact match requirement.
    • Method Detail

      • values

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

        public static RMPrincipalSearchType 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
      • getIntValue

        public int getIntValue()
        Returns the integer value associated with this member.
        Returns:
        An int value.
      • getInstanceFromInt

        public static RMPrincipalSearchType getInstanceFromInt(int intValue)
        Provides the RMPrincipalSearchType instance that corresponds to the given int value.
        Parameters:
        intValue - the int value to look up.
        Returns:
        A RMPrincipalSearchType value or null if no such value corresponds to the given intValue parameter.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.