Package oracle.dbtools.plugin.api.conf

Interface Configuration

public interface Configuration

Represents a set of configuration properties. Each configuration property is identified by a unique string.

Author:

cdivilly

<section role="region">

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	get(java.lang.String name)	Get a property value
default java.lang.String	get(java.lang.String name, java.lang.String defaultValue)	Get a property value
java.lang.String	getPassword(java.lang.String name)	Retrieves an encrypted configuration property (typically passwords).
int	hashCode()
java.lang.Iterable<java.lang.String>	propertyNames()	Enumerates the name of each defined configuration property.

</section>

<section role="region">

Method Detail

equals

boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

get

java.lang.String get(java.lang.String name)

Get a property value

Parameters:

name - The name of the property

Returns:

The value or null if the property is not defined

get

default java.lang.String get(java.lang.String name,
                             java.lang.String defaultValue)

Get a property value

Parameters:

name - The name of the property

defaultValue - a default value to return if the property is not defined

Returns:

The value if it exists, or the value of the defaultValue parameter if it does not exist.

getPassword

java.lang.String getPassword(java.lang.String name)

Retrieves an encrypted configuration property (typically passwords).

Parameters:

name - Name of the configuration property

Returns:

the decrypted value or null if the value is not defined.

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

propertyNames

java.lang.Iterable<java.lang.String> propertyNames()

Enumerates the name of each defined configuration property.

Returns:

Set of property names

</section>