com.ibm.jarm.api.constants

Enum RetainMetadata

  • java.lang.Object
    • java.lang.Enum<RetainMetadata>
      • com.ibm.jarm.api.constants.RetainMetadata
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RetainMetadata>


    public enum RetainMetadata
    extends java.lang.Enum<RetainMetadata>
    Enumerated values for Retain Metadata option. Retain Metadata controls the behavior of delete operations on various IBM Enterprise Records entity types.
    See Also:
    FilePlan.getRetainMetadata
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      AlwaysRetain
      Always retain metadata.
      NeverRetain
      Never retain metadata.
      PromptUser
      Prompt the user to retain or not to retain metadata.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static RetainMetadata getInstanceFromInt(int intValue)
      Provides the RetainMetadata instance that corresponds to the given int value.
      int getIntValue()
      Returns the integer value associated with this member.
      static RetainMetadata valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RetainMetadata[] 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

      • AlwaysRetain

        public static final RetainMetadata AlwaysRetain
        Always retain metadata.
      • NeverRetain

        public static final RetainMetadata NeverRetain
        Never retain metadata.
      • PromptUser

        public static final RetainMetadata PromptUser
        Prompt the user to retain or not to retain metadata.
    • Method Detail

      • values

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

        public static RetainMetadata 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 RetainMetadata getInstanceFromInt(int intValue)
        Provides the RetainMetadata instance that corresponds to the given int value.
        Parameters:
        intValue - the int value to look up.
        Returns:
        A RetainMetadata value or null if no such value corresponds to the given intValue parameter.

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