Package oracle.pgx.config

Interface ConfigField

All Known Implementing Classes:

AnalysisTaskConfig.Field, AuthorizationEntityConfig.Field, AuthorizationEntityPermissionConfig.Field, AuthorizationLocationConfig.Field, BasicSchedulerConfig.Field, ClientConfig.Field, DataMemoryLimitsConfig.Field, EnterpriseSchedulerConfig.Field, EnterpriseSchedulerFlagsConfig.Field, EsEntityProviderConfig.Field, ExternalStoreConfig.Field, FileEntityProviderConfig.Field, FileGraphConfig.Field, FileGraphStoringConfig.Field, FilterExpressionConfig.Field, FrontierRedactedVerticesConfig.Field, GraphBuilderConfig.Field, GraphErrorHandlingConfig.Field, GraphLoadingConfig.Field, GraphPropertyConfig.Field, PartitionedGraphConfig.Field, PgHbaseGraphConfig.Field, PgNosqlGraphConfig.Field, PgRdbmsGraphConfig.Field, PgxConfig.Field, PreloadGraphConfig.Field, PreparedQueryArgumentConfig.Field, PreparedQueryConfig.Field, PropertiesRedactionRuleConfig.Field, ProviderLoadingConfig.Field, RdbmsEntityProviderConfig.Field, RdfGraphConfig.Field, RdfGraphPrefixConfig.Field, RealmConfig.Field, RuntimeConfig.Field, TwoTablesRdbmsGraphConfig.Field, TwoTablesTextGraphConfig.Field, UdfConfig.Field, UdfFunctionArgumentConfig.Field, UdfFunctionConfig.Field

public interface ConfigField

A field in a config.

Method Summary

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.
default boolean	isEnum()	Checks if this field is of enum type.
boolean	isHidden()	Checks if this field should be hidden.
boolean	isPath()	Checks if this field is a path.
default boolean	isPrimitive()	Checks if this field is of primitive type.
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.

Method Detail

getType

java.lang.Class<?> getType()

Gets the type of this field.

Returns:

the type

isRequired

boolean isRequired()

Checks if this field is required.

Returns:

true, if required

isArray

boolean isArray()

Checks if this field is an array.

Returns:

true, if array

isPath

boolean isPath()

Checks if this field is a path.

Returns:

true, if path

getDefaultVal

java.lang.Object getDefaultVal()

Gets the default value of this field.

Returns:

the default value

isPrimitive

default boolean isPrimitive()

Checks if this field is of primitive type.

Returns:

true, if primitive

isEnum

default boolean isEnum()

Checks if this field is of enum type.

Returns:

true, if enum

toKey

java.lang.String toKey()

Get the key of this field, which is how this field is represented in serialized form.

Returns:

the key.

getKeyAliases

java.util.List<java.lang.String> getKeyAliases()

Gets the key aliases of this field which are also recognized during parsing.

Returns:

the key aliases

getSingletonListKeyAliases

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.

Returns:

the singleton list key aliases

isSensitive

boolean isSensitive()

Checks if this field holds a sensitive data.

Returns:

true, if use for sensitive data

isHidden

boolean isHidden()

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.

Returns:

true if field should be hidden, false otherwise