Package oracle.pgx.config

Class ExternalStoreConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.ExternalStoreConfig

@Generated("config_generator.py")
public class ExternalStoreConfig
extends AbstractConfig

External store configuration details

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalStoreConfig.Field	Fields of External store configuration details

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static ExternalStoreConfig.Field[]	getConfigFields()
java.lang.String	getIdentifier()	The identifier that identifies the unique implementation for the external store API.
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.String	getName()	The name with which this external store is referenced from the property description.
java.util.Map	getOptions()	Freely formatted options that are passed to the implementation for the external store API.
java.util.Map<ExternalStoreConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<ExternalStoreConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(ExternalStoreConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static ExternalStoreConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static ExternalStoreConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static ExternalStoreConfig	parse(java.util.Properties props, boolean strict)	Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

parse

public static ExternalStoreConfig parse(java.io.InputStream is,
                                        boolean strict,
                                        java.lang.String parentPath)
                                 throws java.io.IOException

Parses an input stream.

Parameters:

is - the input stream

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static ExternalStoreConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                        boolean strict,
                                        java.lang.String parentPath)

Parses a raw key/value mapping.

Parameters:

raw - the raw key/value mapping to parse

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

parse

public static ExternalStoreConfig parse(java.util.Properties props,
                                        boolean strict)

Parses a properties file.

Parameters:

props - the properties to parse

strict - if true, parses in strict mode

Returns:

the parsed graph config

getConfigFields

public static ExternalStoreConfig.Field[] getConfigFields()

getValues

public java.util.Map<ExternalStoreConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Specified by:

getValues in class AbstractConfig

Returns:

the parsed values

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

hasDefaultValue

public boolean hasDefaultValue(ExternalStoreConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

getValuesWithoutDefaults

public java.util.Map<ExternalStoreConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getLeftoverValues

public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()

Gets the values that do not belong to any field.

Returns:

the values that do not belong to any field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

getName

public java.lang.String getName()

The name with which this external store is referenced from the property description.

getIdentifier

public java.lang.String getIdentifier()

The identifier that identifies the unique implementation for the external store API.

getOptions

public java.util.Map getOptions()

Freely formatted options that are passed to the implementation for the external store API.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object