Top Description Fields Constructors Methods
com.typesafe.config.impl

pack-priv final Class ConfigReference

extends AbstractConfigValue
implements Unmergeable
Class Inheritance
All Implemented Interfaces
com.typesafe.config.impl.Unmergeable
Imports
java.util.Collection, .Collections, com.typesafe.config.ConfigException, .ConfigOrigin, .ConfigRenderOptions, .ConfigResolveOptions, .ConfigValue, .ConfigValueType

ConfigReference replaces ConfigReference (the older class kept for back compat) and represents the ${} substitution syntax. It can resolve to any kind of value.

Field Summary

Modifier and TypeField and Description
private final SubstitutionExpression
private final int

Constructor Summary

AccessConstructor and Description
pack-priv
private
ConfigReference(ConfigOrigin origin, SubstitutionExpression expr, int prefixLength)

Method Summary

Modifier and TypeMethod and Description
protected boolean
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides com.typesafe.config.impl.AbstractConfigValue.equals.

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

pack-priv SubstitutionExpression
public int
hashCode()

Overrides com.typesafe.config.impl.AbstractConfigValue.hashCode.

Returns a hash code value for this object.

protected boolean
protected ConfigReference
private ConfigException.NotResolved
pack-priv ConfigReference
relativized(Path prefix)

Overrides com.typesafe.config.impl.AbstractConfigValue.relativized.

This is used when including one file in another; the included file is relativized to the path it's included into in the parent file.

protected void
pack-priv ResolveStatus
pack-priv ResolveResult<? extends AbstractConfigValue>
resolveSubstitutions(ResolveContext
state of the current resolve
context
,
ResolveSource
where to look up values
source
)

Overrides com.typesafe.config.impl.AbstractConfigValue.resolveSubstitutions.

Called only by ResolveContext.resolve().

public Collection<ConfigReference>
public Object
unwrapped()

Implements com.typesafe.config.ConfigValue.unwrapped.

Returns the value as a plain Java boxed value, that is, a String, Number, Boolean, Map<String,Object>, List<Object>, or null, matching the valueType() of this ConfigValue.

public ConfigValueType
valueType()

Implements com.typesafe.config.ConfigValue.valueType.

The ConfigValueType of the value; matches the JSON type schema.

Inherited from com.typesafe.config.impl.AbstractConfigValue:
appendHiddenEnvVariableValueatKeyatKeyatPathatPathconstructDelayedMergehasDescendantInListhideEnvVariableValueindentmergedWithNonObjectmergedWithNonObjectmergedWithObjectmergedWithObjectmergedWithTheUnmergeablemergedWithTheUnmergeableoriginrenderrenderrenderreplaceChildInListrequireNotIgnoringFallbackstoFallbackValuetoStringtransformToStringwithFallbackwithFallbacksIgnoredwithOrigin

Field Detail

exprback to summary
private final SubstitutionExpression expr
prefixLengthback to summary
private final int prefixLength

Constructor Detail

ConfigReferenceback to summary
pack-priv ConfigReference(ConfigOrigin origin, SubstitutionExpression expr)
ConfigReferenceback to summary
private ConfigReference(ConfigOrigin origin, SubstitutionExpression expr, int prefixLength)

Method Detail

canEqualback to summary
protected boolean canEqual(Object other)

Overrides com.typesafe.config.impl.AbstractConfigValue.canEqual.

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides com.typesafe.config.impl.AbstractConfigValue.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
expressionback to summary
pack-priv SubstitutionExpression expression()
hashCodeback to summary
public int hashCode()

Overrides com.typesafe.config.impl.AbstractConfigValue.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
ignoresFallbacksback to summary
protected boolean ignoresFallbacks()

Overrides com.typesafe.config.impl.AbstractConfigValue.ignoresFallbacks.

Annotations
@Override
newCopyback to summary
protected ConfigReference newCopy(ConfigOrigin newOrigin)

Implements abstract com.typesafe.config.impl.AbstractConfigValue.newCopy.

Annotations
@Override
notResolvedback to summary
private ConfigException.NotResolved notResolved()
relativizedback to summary
pack-priv ConfigReference relativized(Path prefix)

Overrides com.typesafe.config.impl.AbstractConfigValue.relativized.

Doc from com.typesafe.config.impl.AbstractConfigValue.relativized.

This is used when including one file in another; the included file is relativized to the path it's included into in the parent file. The point is that if you include a file at foo.bar in the parent, and the included file as a substitution ${a.b.c}, the included substitution now needs to be ${foo.bar.a.b.c} because we resolve substitutions globally only after parsing everything.

Returns:ConfigReference

value relativized to the given path or the same value if nothing to do

Annotations
@Override
renderback to summary
protected void render(StringBuilder sb, int indent, boolean atRoot, ConfigRenderOptions options)

Overrides com.typesafe.config.impl.AbstractConfigValue.render.

Annotations
@Override
resolveStatusback to summary
pack-priv ResolveStatus resolveStatus()

Overrides com.typesafe.config.impl.AbstractConfigValue.resolveStatus.

Annotations
@Override
resolveSubstitutionsback to summary
pack-priv ResolveResult<? extends AbstractConfigValue> resolveSubstitutions(ResolveContext context, ResolveSource source)

Overrides com.typesafe.config.impl.AbstractConfigValue.resolveSubstitutions.

Doc from com.typesafe.config.impl.AbstractConfigValue.resolveSubstitutions.

Called only by ResolveContext.resolve().

Parameters
context:ResolveContext

state of the current resolve

source:ResolveSource

where to look up values

Returns:ResolveResult<? extends AbstractConfigValue>

a new value if there were changes, or this if no changes

Annotations
@Override
unmergedValuesback to summary
public Collection<ConfigReference> unmergedValues()

Implements com.typesafe.config.impl.Unmergeable.unmergedValues.

Annotations
@Override
unwrappedback to summary
public Object unwrapped()

Implements com.typesafe.config.ConfigValue.unwrapped.

Doc from com.typesafe.config.ConfigValue.unwrapped.

Returns the value as a plain Java boxed value, that is, a String, Number, Boolean, Map<String,Object>, List<Object>, or null, matching the valueType() of this ConfigValue. If the value is a ConfigObject or ConfigList, it is recursively unwrapped.

Returns:Object

a plain Java value corresponding to this ConfigValue

Annotations
@Override
valueTypeback to summary
public ConfigValueType valueType()

Implements com.typesafe.config.ConfigValue.valueType.

Doc from com.typesafe.config.ConfigValue.valueType.

The ConfigValueType of the value; matches the JSON type schema.

Returns:ConfigValueType

value's type

Annotations
@Override