Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
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 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.
Attributes
- Returns
-
any comments that seemed to "go with" this origin, empty list if none
- Definition Classes
Returns a string describing the origin of a value or exception. This will never return null.
Returns a string describing the origin of a value or exception. This will never return null.
Attributes
- Returns
-
string describing the origin
- Definition Classes
Compares the receiver object (this) with the argument object (that) for equivalence.
Compares the receiver object (this) with the argument object (that) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).
Value parameters
- that
-
the object to compare against this object for equality.
Attributes
- Returns
-
trueif the receiver object is equivalent to the argument;falseotherwise. - Definition Classes
-
Any
Returns a filename describing the origin. This will return null if the origin was not a file.
Returns a filename describing the origin. This will return null if the origin was not a file.
Attributes
- Returns
-
filename of the origin or null
- Definition Classes
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
Attributes
- Returns
-
the hash code value for this object.
- Definition Classes
-
Any
Returns a line number where the value or exception originated. This will return -1 if there's no meaningful line number.
Returns a line number where the value or exception originated. This will return -1 if there's no meaningful line number.
Attributes
- Returns
-
line number or -1 if none is available
- Definition Classes
Returns a classpath resource name describing the origin. This will return null if the origin was not a classpath resource.
Returns a classpath resource name describing the origin. This will return null if the origin was not a classpath resource.
Attributes
- Returns
-
resource name of the origin or null
- Definition Classes
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any
Returns a URL describing the origin. This will return null if the origin has no meaningful URL.
Returns a URL describing the origin. This will return null if the origin has no meaningful URL.
Attributes
- Returns
-
url of the origin or null
- Definition Classes
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.
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.
Value parameters
- comments
-
the comments used on the returned origin
Attributes
- Returns
-
the ConfigOrigin with the given comments
- Since
-
1.3.0
- Definition Classes
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.
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.
Value parameters
- lineNumber
-
the new line number
Attributes
- Returns
-
the created ConfigOrigin
- Since
-
1.3.0
- Definition Classes