pack-priv final Class SimpleConfigDocument

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Implements com.typesafe.config.parser.ConfigDocument.hasPath.

Doc from com.typesafe.config.parser.ConfigDocument.hasPath.

Returns a boolean indicating whether or not a ConfigDocument has a value at the desired path. null counts as a value for purposes of this check.

Parameters

path:String

the path to check

Returns:boolean

true if the path exists in the document, otherwise false

Annotations

@Override

Implements com.typesafe.config.parser.ConfigDocument.render.

Doc from com.typesafe.config.parser.ConfigDocument.render.

The original text of the input, modified if necessary with any replaced or added values.

Returns:String

the modified original text

Implements com.typesafe.config.parser.ConfigDocument.withoutPath.

Doc from com.typesafe.config.parser.ConfigDocument.withoutPath.

Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with all values at the desired path removed. If the path does not exist in the document, a copy of the current document will be returned. If there is an array at the root, an exception will be thrown.

Parameters

path:String

the path to remove from the document

Returns:ConfigDocument

a copy of the ConfigDocument with the desired value removed from the document.

Annotations

@Override

Implements com.typesafe.config.parser.ConfigDocument.withValue.

Doc from com.typesafe.config.parser.ConfigDocument.withValue.

Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path. Works like withValueText(String, String), but takes a ConfigValue instead of a string.

Parameters

path:String

the path at which to set the desired value

newValue:ConfigValue

the value to set at the desired path, represented as a ConfigValue. The rendered text of the ConfigValue will be inserted into the ConfigDocument.

Returns:ConfigDocument

a copy of the ConfigDocument with the desired value at the desired path

Annotations

@Override

Implements com.typesafe.config.parser.ConfigDocument.withValueText.

Doc from com.typesafe.config.parser.ConfigDocument.withValueText.

Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path. If the path exists, it will remove all duplicates before the final occurrence of the path, and replace the value at the final occurrence of the path. If the path does not exist, it will be added. If the document has an array as the root value, an exception will be thrown.

Parameters

path:String

the path at which to set the desired value

newValue:String

the value to set at the desired path, represented as a string. This string will be parsed into a ConfigNode using the same options used to parse the entire document, and the text will be inserted as-is into the document. Leading and trailing comments, whitespace, or newlines are not allowed, and if present an exception will be thrown. If a concatenation is passed in for newValue but the document was parsed with JSON, the first value in the concatenation will be parsed and inserted into the ConfigDocument.

Returns:ConfigDocument

a copy of the ConfigDocument with the desired value at the desired path

Annotations

@Override