Typesafe Config 1.4.3 · com.typesafe.config.ConfigMemorySize

Modifier and Type	Field and Description
private BigInteger	bytes

Access	Constructor and Description
private	ConfigMemorySize(BigInteger bytes)

Modifier and Type	Method and Description
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.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static ConfigMemorySize	Returns: an instance representing the number of bytes ofBytes(BigInteger a number of bytes bytes) Constructs a ConfigMemorySize representing the given number of bytes.
public static ConfigMemorySize	Returns: an instance representing the number of bytes ofBytes(long a number of bytes bytes) Constructs a ConfigMemorySize representing the given number of bytes.
public long	Returns: how many bytes toBytes() Gets the size in bytes.
public BigInteger	Returns: how many bytes toBytesBigInteger() Gets the size in bytes.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

bytes	back to summary
private BigInteger bytes

ConfigMemorySize	back to summary
private ConfigMemorySize(BigInteger bytes)

Method Detail

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)

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

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

ofBytes	back to summary
public static ConfigMemorySize ofBytes(BigInteger bytes) Constructs a ConfigMemorySize representing the given number of bytes. Parameters bytes:BigInteger a number of bytes Returns:ConfigMemorySize an instance representing the number of bytes Since 1.3.0

ofBytes

back to summary

public static ConfigMemorySize ofBytes(BigInteger bytes)

Constructs a ConfigMemorySize representing the given number of bytes.

Parameters

bytes:BigInteger: a number of bytes

Returns:ConfigMemorySize

an instance representing the number of bytes

Since

1.3.0

ofBytes	back to summary
public static ConfigMemorySize ofBytes(long bytes) Constructs a ConfigMemorySize representing the given number of bytes. Parameters bytes:long a number of bytes Returns:ConfigMemorySize an instance representing the number of bytes

ofBytes

back to summary

public static ConfigMemorySize ofBytes(long bytes)

Constructs a ConfigMemorySize representing the given number of bytes.

Parameters

bytes:long: a number of bytes

Returns:ConfigMemorySize

an instance representing the number of bytes

toBytes back to summary

toBytes	back to summary
public long toBytes() Gets the size in bytes. Returns:long how many bytes Exceptions IllegalArgumentException: when memory value in bytes doesn't fit in a long value. Consider using `toBytesBigInteger` in this case. Since 1.3.0

public long toBytes()

Gets the size in bytes.

Returns:long

how many bytes

Exceptions

IllegalArgumentException:: when memory value in bytes doesn't fit in a long value. Consider using toBytesBigInteger in this case.

Since

1.3.0

toBytesBigInteger back to summary

toBytesBigInteger	back to summary
public BigInteger toBytesBigInteger() Gets the size in bytes. The behavior of this method is the same as that of the `toBytes()` method, except that the number of bytes returned as a BigInteger value. Use it when memory value in bytes doesn't fit in a long value. Returns:BigInteger how many bytes

public BigInteger toBytesBigInteger()

Gets the size in bytes. The behavior of this method is the same as that of the toBytes() method, except that the number of bytes returned as a BigInteger value. Use it when memory value in bytes doesn't fit in a long value.

Returns:BigInteger: how many bytes

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

public final Class ConfigMemorySize

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail