Typesafe Config 1.4.3 · com.typesafe.config.impl.SimpleConfigOrigin

Modifier and Type	Field and Description
private final List<String>	commentsOrNull
private final String	description
private final int	endLineNumber
private final int	lineNumber
pack-priv static final String	MERGE_OF_PREFIX
private final OriginType	originType
private final String	resourceOrNull
private final String	urlOrNull

Access	Constructor and Description
protected	SimpleConfigOrigin(String description, int lineNumber, int endLineNumber, OriginType originType, String urlOrNull, String resourceOrNull, List<String> commentsOrNull)

Modifier and Type	Method and Description
pack-priv SimpleConfigOrigin	addURL(URL url)
pack-priv SimpleConfigOrigin	appendComments(List<String> comments)
pack-priv static Map<SerializedConfigValue.SerializedField, Object>	applyFieldsDelta(Map<SerializedConfigValue.SerializedField, Object> base, Map<SerializedConfigValue.SerializedField, Object> delta)
public List<String>	comments() Implements com.typesafe.config.ConfigOrigin.comments. Returns any comments that appeared to "go with" this place in the file.
public String	description() Implements com.typesafe.config.ConfigOrigin.description. Returns a string describing the origin of a value or exception.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv static Map<SerializedConfigValue.SerializedField, Object>	fieldsDelta(Map<SerializedConfigValue.SerializedField, Object> base, Map<SerializedConfigValue.SerializedField, Object> child)
public String	filename() Implements com.typesafe.config.ConfigOrigin.filename. Returns a filename describing the origin.
pack-priv static SimpleConfigOrigin	fromBase(SimpleConfigOrigin baseOrigin, Map<SerializedConfigValue.SerializedField, Object> delta)
pack-priv static SimpleConfigOrigin	fromFields(Map<SerializedConfigValue.SerializedField, Object> m)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	lineNumber() Implements com.typesafe.config.ConfigOrigin.lineNumber. Returns a line number where the value or exception originated.
pack-priv static ConfigOrigin	mergeOrigins(ConfigOrigin a, ConfigOrigin b)
pack-priv static ConfigOrigin	mergeOrigins(List<? extends AbstractConfigValue> stack)
pack-priv static ConfigOrigin	mergeOrigins(Collection<? extends ConfigOrigin> stack)
private static SimpleConfigOrigin	mergeThree(SimpleConfigOrigin a, SimpleConfigOrigin b, SimpleConfigOrigin c)
private static SimpleConfigOrigin	mergeTwo(SimpleConfigOrigin a, SimpleConfigOrigin b)
pack-priv static SimpleConfigOrigin	newEnvVariable(String description)
pack-priv static SimpleConfigOrigin	newFile(String filename)
pack-priv static SimpleConfigOrigin	newResource(String resource, URL url)
pack-priv static SimpleConfigOrigin	newResource(String resource)
pack-priv static SimpleConfigOrigin	newSimple(String description)
pack-priv static SimpleConfigOrigin	newURL(URL url)
pack-priv OriginType	originType()
pack-priv SimpleConfigOrigin	prependComments(List<String> comments)
public String	resource() Implements com.typesafe.config.ConfigOrigin.resource. Returns a classpath resource name describing the origin.
private static int	similarity(SimpleConfigOrigin a, SimpleConfigOrigin b)
pack-priv Map<SerializedConfigValue.SerializedField, Object>	toFields()
pack-priv Map<SerializedConfigValue.SerializedField, Object>	toFieldsDelta(SimpleConfigOrigin baseOrigin)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public URL	url() Implements com.typesafe.config.ConfigOrigin.url. Returns a URL describing the origin.
public SimpleConfigOrigin	withComments(List<String> the comments used on the returned origin comments) Implements com.typesafe.config.ConfigOrigin.withComments. Returns a `ConfigOrigin` based on this one, but with the given comments.
public SimpleConfigOrigin	withLineNumber(int the new line number lineNumber) Implements com.typesafe.config.ConfigOrigin.withLineNumber. Returns a `ConfigOrigin` based on this one, but with the given line number.

commentsOrNull	back to summary
private final List<String> commentsOrNull

description	back to summary
private final String description

endLineNumber	back to summary
private final int endLineNumber

lineNumber	back to summary
private final int lineNumber

MERGE_OF_PREFIX	back to summary
pack-priv static final String MERGE_OF_PREFIX

originType	back to summary
private final OriginType originType

resourceOrNull	back to summary
private final String resourceOrNull

urlOrNull	back to summary
private final String urlOrNull

SimpleConfigOrigin	back to summary
protected SimpleConfigOrigin(String description, int lineNumber, int endLineNumber, OriginType originType, String urlOrNull, String resourceOrNull, List<String> commentsOrNull)

Method Detail

addURL	back to summary
pack-priv SimpleConfigOrigin addURL(URL url)

appendComments	back to summary
pack-priv SimpleConfigOrigin appendComments(List<String> comments)

applyFieldsDelta	back to summary
pack-priv static Map<SerializedConfigValue.SerializedField, Object> applyFieldsDelta(Map<SerializedConfigValue.SerializedField, Object> base, Map<SerializedConfigValue.SerializedField, Object> delta) throws IOException

comments	back to summary
public List<String> comments() Implements com.typesafe.config.ConfigOrigin.comments. Doc from com.typesafe.config.ConfigOrigin.comments. Returns any comments that appeared to "go with" this place in the file. Often an empty list, but never null. The details of this are subject to change, but at the moment comments that are immediately before an array element or object field, with no blank line after the comment, "go with" that element or field. Returns:List<String> any comments that seemed to "go with" this origin, empty list if none Annotations @Override

comments

back to summary

public List<String> comments()

Implements com.typesafe.config.ConfigOrigin.comments.

Doc from com.typesafe.config.ConfigOrigin.comments.

Returns any comments that appeared to "go with" this place in the file. Often an empty list, but never null. The details of this are subject to change, but at the moment comments that are immediately before an array element or object field, with no blank line after the comment, "go with" that element or field.

Returns:List<String>

any comments that seemed to "go with" this origin, empty list if none

Annotations

@Override

description	back to summary
public String description() Implements com.typesafe.config.ConfigOrigin.description. Doc from com.typesafe.config.ConfigOrigin.description. Returns a string describing the origin of a value or exception. This will never return null. Returns:String string describing the origin Annotations @Override

description

back to summary

public String description()

Implements com.typesafe.config.ConfigOrigin.description.

Doc from com.typesafe.config.ConfigOrigin.description.

Returns a string describing the origin of a value or exception. This will never return null.

Returns:String

string describing the origin

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) 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

public boolean equals(Object other)

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

fieldsDelta	back to summary
pack-priv static Map<SerializedConfigValue.SerializedField, Object> fieldsDelta(Map<SerializedConfigValue.SerializedField, Object> base, Map<SerializedConfigValue.SerializedField, Object> child)

filename	back to summary
public String filename() Implements com.typesafe.config.ConfigOrigin.filename. Doc from com.typesafe.config.ConfigOrigin.filename. Returns a filename describing the origin. This will return null if the origin was not a file. Returns:String filename of the origin or null Annotations @Override

filename

back to summary

public String filename()

Implements com.typesafe.config.ConfigOrigin.filename.

Doc from com.typesafe.config.ConfigOrigin.filename.

Returns a filename describing the origin. This will return null if the origin was not a file.

Returns:String

filename of the origin or null

Annotations

@Override

fromBase	back to summary
pack-priv static SimpleConfigOrigin fromBase(SimpleConfigOrigin baseOrigin, Map<SerializedConfigValue.SerializedField, Object> delta) throws IOException

fromFields	back to summary
pack-priv static SimpleConfigOrigin fromFields(Map<SerializedConfigValue.SerializedField, Object> m) throws IOException

hashCode back to summary

hashCode	back to summary
public int hashCode() 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

public int hashCode()

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

lineNumber	back to summary
public int lineNumber() Implements com.typesafe.config.ConfigOrigin.lineNumber. Doc from com.typesafe.config.ConfigOrigin.lineNumber. Returns a line number where the value or exception originated. This will return -1 if there's no meaningful line number. Returns:int line number or -1 if none is available Annotations @Override

lineNumber

back to summary

public int lineNumber()

Implements com.typesafe.config.ConfigOrigin.lineNumber.

Doc from com.typesafe.config.ConfigOrigin.lineNumber.

Returns a line number where the value or exception originated. This will return -1 if there's no meaningful line number.

Returns:int

line number or -1 if none is available

Annotations

@Override

mergeOrigins	back to summary
pack-priv static ConfigOrigin mergeOrigins(ConfigOrigin a, ConfigOrigin b)

mergeOrigins	back to summary
pack-priv static ConfigOrigin mergeOrigins(List<? extends AbstractConfigValue> stack)

mergeOrigins	back to summary
pack-priv static ConfigOrigin mergeOrigins(Collection<? extends ConfigOrigin> stack)

mergeThree	back to summary
private static SimpleConfigOrigin mergeThree(SimpleConfigOrigin a, SimpleConfigOrigin b, SimpleConfigOrigin c)

mergeTwo	back to summary
private static SimpleConfigOrigin mergeTwo(SimpleConfigOrigin a, SimpleConfigOrigin b)

newEnvVariable	back to summary
pack-priv static SimpleConfigOrigin newEnvVariable(String description)

newFile	back to summary
pack-priv static SimpleConfigOrigin newFile(String filename)

newResource	back to summary
pack-priv static SimpleConfigOrigin newResource(String resource, URL url)

newResource	back to summary
pack-priv static SimpleConfigOrigin newResource(String resource)

newSimple	back to summary
pack-priv static SimpleConfigOrigin newSimple(String description)

newURL	back to summary
pack-priv static SimpleConfigOrigin newURL(URL url)

originType	back to summary
pack-priv OriginType originType()

prependComments	back to summary
pack-priv SimpleConfigOrigin prependComments(List<String> comments)

resource	back to summary
public String resource() Implements com.typesafe.config.ConfigOrigin.resource. Doc from com.typesafe.config.ConfigOrigin.resource. Returns a classpath resource name describing the origin. This will return null if the origin was not a classpath resource. Returns:String resource name of the origin or null Annotations @Override

resource

back to summary

public String resource()

Implements com.typesafe.config.ConfigOrigin.resource.

Doc from com.typesafe.config.ConfigOrigin.resource.

Returns a classpath resource name describing the origin. This will return null if the origin was not a classpath resource.

Returns:String

resource name of the origin or null

Annotations

@Override

similarity	back to summary
private static int similarity(SimpleConfigOrigin a, SimpleConfigOrigin b)

toFields	back to summary
pack-priv Map<SerializedConfigValue.SerializedField, Object> toFields()

toFieldsDelta	back to summary
pack-priv Map<SerializedConfigValue.SerializedField, Object> toFieldsDelta(SimpleConfigOrigin baseOrigin)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

url	back to summary
public URL url() Implements com.typesafe.config.ConfigOrigin.url. Doc from com.typesafe.config.ConfigOrigin.url. Returns a URL describing the origin. This will return null if the origin has no meaningful URL. Returns:URL url of the origin or null Annotations @Override

url

back to summary

public URL url()

Implements com.typesafe.config.ConfigOrigin.url.

Doc from com.typesafe.config.ConfigOrigin.url.

Returns a URL describing the origin. This will return null if the origin has no meaningful URL.

Returns:URL

url of the origin or null

Annotations

@Override

withComments back to summary

withComments	back to summary
public SimpleConfigOrigin withComments(List<String> comments) Implements com.typesafe.config.ConfigOrigin.withComments. Doc from com.typesafe.config.ConfigOrigin.withComments. Returns a `ConfigOrigin` based on this one, but with the given comments. Does not modify this instance or any `ConfigValue`s with this origin (since they are immutable). To set the returned origin to a `ConfigValue`, use `ConfigValue#withOrigin`. Note that when the given comments are equal to the comments on this object, a new instance may not be created and `this` is returned directly. Parameters comments:List<String> the comments used on the returned origin Returns:SimpleConfigOrigin the ConfigOrigin with the given comments Annotations @Override

public SimpleConfigOrigin withComments(List<String> comments)

Implements com.typesafe.config.ConfigOrigin.withComments.

Doc from com.typesafe.config.ConfigOrigin.withComments.

Returns a ConfigOrigin based on this one, but with the given comments. Does not modify this instance or any ConfigValues with this origin (since they are immutable). To set the returned origin to a ConfigValue, use ConfigValue#withOrigin.

Note that when the given comments are equal to the comments on this object, a new instance may not be created and this is returned directly.

Parameters

comments:List<String>: the comments used on the returned origin

Returns:SimpleConfigOrigin

the ConfigOrigin with the given comments

Annotations

@Override

withLineNumber back to summary

withLineNumber	back to summary
public SimpleConfigOrigin withLineNumber(int lineNumber) Implements com.typesafe.config.ConfigOrigin.withLineNumber. Doc from com.typesafe.config.ConfigOrigin.withLineNumber. Returns a `ConfigOrigin` based on this one, but with the given line number. This origin must be a FILE, URL or RESOURCE. Does not modify this instance or any `ConfigValue`s with this origin (since they are immutable). To set the returned origin to a `ConfigValue`, use `ConfigValue#withOrigin`. Note that when the given lineNumber are equal to the lineNumber on this object, a new instance may not be created and `this` is returned directly. Parameters lineNumber:int the new line number Returns:SimpleConfigOrigin the created ConfigOrigin Annotations @Override

public SimpleConfigOrigin withLineNumber(int lineNumber)

Implements com.typesafe.config.ConfigOrigin.withLineNumber.

Doc from com.typesafe.config.ConfigOrigin.withLineNumber.

Returns a ConfigOrigin based on this one, but with the given line number. This origin must be a FILE, URL or RESOURCE. Does not modify this instance or any ConfigValues with this origin (since they are immutable). To set the returned origin to a ConfigValue, use ConfigValue#withOrigin.

Note that when the given lineNumber are equal to the lineNumber on this object, a new instance may not be created and this is returned directly.

Parameters

lineNumber:int: the new line number

Returns:SimpleConfigOrigin

the created ConfigOrigin

Annotations

@Override

pack-priv final Class SimpleConfigOrigin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail