Package oracle.pgx.config

Enum ExternalStoreConfig.Field

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      IDENTIFIER
      The identifier that identifies the unique implementation for the external store API.
      NAME
      The name with which this external store is referenced from the property description.
      OPTIONS
      Freely formatted options that are passed to the implementation for the external store API.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getDefaultVal()
      Gets the default value of this field.
      java.util.List<java.lang.String> getKeyAliases()
      Gets the key aliases of this field which are also recognized during parsing.
      java.util.List<java.lang.String> getSingletonListKeyAliases()
      Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
      java.lang.Class<?> getType()
      Gets the type of this field.
      boolean isArray()
      Checks if this field is an array.
      boolean isHidden()
      Checks if this field should be hidden.
      boolean isPath()
      Checks if this field is a path.
      boolean isRequired()
      Checks if this field is required.
      boolean isSensitive()
      Checks if this field holds a sensitive data.
      java.lang.String toKey()
      Get the key of this field, which is how this field is represented in serialized form.
      java.lang.String toString()  
      static ExternalStoreConfig.Field valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ExternalStoreConfig.Field[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NAME

        public static final ExternalStoreConfig.Field NAME
        The name with which this external store is referenced from the property description.

      • IDENTIFIER

        public static final ExternalStoreConfig.Field IDENTIFIER
        The identifier that identifies the unique implementation for the external store API.

      • OPTIONS

        public static final ExternalStoreConfig.Field OPTIONS
        Freely formatted options that are passed to the implementation for the external store API.

    • Method Detail

      • values

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

      • valueOf

        public static ExternalStoreConfig.Field 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

      • getKeyAliases

        public java.util.List<java.lang.String> getKeyAliases()
        Description copied from interface: ConfigField
        Gets the key aliases of this field which are also recognized during parsing.
        Specified by:
        getKeyAliases in interface ConfigField
        Returns:
        the key aliases

      • getSingletonListKeyAliases

        public java.util.List<java.lang.String> getSingletonListKeyAliases()
        Description copied from interface: ConfigField
        Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
        Specified by:
        getSingletonListKeyAliases in interface ConfigField
        Returns:
        the singleton list key aliases

      • getType

        public java.lang.Class<?> getType()
        Description copied from interface: ConfigField
        Gets the type of this field.
        Specified by:
        getType in interface ConfigField
        Returns:
        the type

      • isRequired

        public boolean isRequired()
        Description copied from interface: ConfigField
        Checks if this field is required.
        Specified by:
        isRequired in interface ConfigField
        Returns:
        true, if required

      • isArray

        public boolean isArray()
        Description copied from interface: ConfigField
        Checks if this field is an array.
        Specified by:
        isArray in interface ConfigField
        Returns:
        true, if array

      • isPath

        public boolean isPath()
        Description copied from interface: ConfigField
        Checks if this field is a path.
        Specified by:
        isPath in interface ConfigField
        Returns:
        true, if path

      • getDefaultVal

        public java.lang.Object getDefaultVal()
        Description copied from interface: ConfigField
        Gets the default value of this field.
        Specified by:
        getDefaultVal in interface ConfigField
        Returns:
        the default value

      • toKey

        public java.lang.String toKey()
        Description copied from interface: ConfigField
        Get the key of this field, which is how this field is represented in serialized form.
        Specified by:
        toKey in interface ConfigField
        Returns:
        the key.

      • isSensitive

        public boolean isSensitive()
        Description copied from interface: ConfigField
        Checks if this field holds a sensitive data.
        Specified by:
        isSensitive in interface ConfigField
        Returns:
        true, if use for sensitive data

      • isHidden

        public boolean isHidden()
        Description copied from interface: ConfigField
        Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
        Specified by:
        isHidden in interface ConfigField
        Returns:
        true if field should be hidden, false otherwise