Top Description Inners Fields Constructors Methods
org.glassfish.tyrus.core.collection

public final Class Values

extends Object
Class Inheritance

A collection of Value provider factory & utility methods.
Author
Marek Potociar

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class
private static class

Field Summary

Modifier and TypeField and Description
private static final LazyValue<T>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static <
value type.
T
>
Value<T>

Returns:

eagerly initialized, constant value provider.
eager
(final Value<T>
value provider delegate that will be used to eagerly initialize the value provider.
delegate
)

Get a new eagerly initialized value provider.

public static <
value type.
T
>
Value<T>

Returns:

empty value provider.
empty
()

Get an empty value provider whose get() method always returns null.

public static <
value type.
T
>
LazyValue<T>

Returns:

lazily initialized value provider.
lazy
(final Value<T>
value provider delegate that will be used to lazily initialize the value provider.
delegate
)

Get a new lazily initialized value provider.

public static <
value type.
T
>
Value<T>

Returns:

constant value provider.
of
(final T
value instance to be provided.
value
)

Get a new constant value provider whose get() method always returns the instance supplied to the value parameter.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

EMPTYback to summary
private static final LazyValue<T> EMPTY

Constructor Detail

Valuesback to summary
private Values()

Method Detail

eagerback to summary
public static <T> Value<T> eager(final Value<T> delegate)

Get a new eagerly initialized value provider.

The value returned by its get() method is eagerly computed from the supplied delegate value provider and is then stored in a final field for a subsequent retrieval.

The implementation of the returned eager value provider is thread-safe and is guaranteed to invoke the get() method on the supplied delegate value provider instance once and only once.

If the supplied value provider is null, an empty value provider is returned.

Parameters
<T>
value type.
delegate:Value<T>

value provider delegate that will be used to eagerly initialize the value provider.

Returns:Value<T>

eagerly initialized, constant value provider.

emptyback to summary
public static <T> Value<T> empty()

Get an empty value provider whose get() method always returns null.

Parameters
<T>
value type.
Returns:Value<T>

empty value provider.

lazyback to summary
public static <T> LazyValue<T> lazy(final Value<T> delegate)

Get a new lazily initialized value provider.

The value returned by its get() method is lazily retrieved during a first call to the method from the supplied delegate value provider and is then cached for a subsequent retrieval.

The implementation of the returned lazy value provider is thread-safe and is guaranteed to invoke the get() method on the supplied delegate value provider instance at most once.

If the supplied value provider is null, an empty value provider is returned.

Parameters
<T>
value type.
delegate:Value<T>

value provider delegate that will be used to lazily initialize the value provider.

Returns:LazyValue<T>

lazily initialized value provider.

ofback to summary
public static <T> Value<T> of(final T value)

Get a new constant value provider whose get() method always returns the instance supplied to the value parameter.

In case the supplied value constant is null, an empty value provider is returned.

Parameters
<T>
value type.
value:T

value instance to be provided.

Returns:Value<T>

constant value provider.

org.glassfish.tyrus.core.collection back to summary

private Class Values.EagerValue<T>

extends Object
implements Value<T>
Class Inheritance
All Implemented Interfaces
org.glassfish.tyrus.core.collection.Value

Field Summary

Modifier and TypeField and Description
private final T

Constructor Summary

AccessConstructor and Description
private
EagerValue(final Value<T> value)

Method Summary

Modifier and TypeMethod and Description
public T
get()

Implements org.glassfish.tyrus.core.collection.Value.get.

Get the stored value.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

resultback to summary
private final T result

Constructor Detail

EagerValueback to summary
private EagerValue(final Value<T> value)

Method Detail

getback to summary
public T get()

Implements org.glassfish.tyrus.core.collection.Value.get.

Doc from org.glassfish.tyrus.core.collection.Value.get.

Get the stored value.

Returns:T

stored value.

Annotations
@Override
org.glassfish.tyrus.core.collection back to summary

private Class Values.InstanceValue<T>

extends Object
implements Value<T>
Class Inheritance
All Implemented Interfaces
org.glassfish.tyrus.core.collection.Value

Field Summary

Modifier and TypeField and Description
private final T

Constructor Summary

AccessConstructor and Description
public
InstanceValue(final T value)

Method Summary

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

Overrides java.lang.Object.equals.

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

public T
get()

Implements org.glassfish.tyrus.core.collection.Value.get.

Get the stored value.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

valueback to summary
private final T value

Constructor Detail

InstanceValueback to summary
public InstanceValue(final T value)

Method Detail

equalsback to summary
public boolean equals(final Object o)

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
o: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
getback to summary
public T get()

Implements org.glassfish.tyrus.core.collection.Value.get.

Doc from org.glassfish.tyrus.core.collection.Value.get.

Get the stored value.

Returns:T

stored value.

Annotations
@Override
hashCodeback 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
toStringback 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
org.glassfish.tyrus.core.collection back to summary

private Class Values.LazyValueImpl<T>

extends Object
implements LazyValue<T>
Class Inheritance
All Implemented Interfaces
org.glassfish.tyrus.core.collection.LazyValue, org.glassfish.tyrus.core.collection.Value

Field Summary

Modifier and TypeField and Description
private final Value<T>
private final Object
private volatile Value<T>

Constructor Summary

AccessConstructor and Description
public
LazyValueImpl(final Value<T> delegate)

Method Summary

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

Overrides java.lang.Object.equals.

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

public T
get()

Implements org.glassfish.tyrus.core.collection.Value.get.

Get the stored value.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isInitialized()

Implements org.glassfish.tyrus.core.collection.LazyValue.isInitialized.

Check if the lazy value has been initialized already (i.e. its get() method has already been called previously) or not.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

delegateback to summary
private final Value<T> delegate
lockback to summary
private final Object lock
valueback to summary
private volatile Value<T> value

Constructor Detail

LazyValueImplback to summary
public LazyValueImpl(final Value<T> delegate)

Method Detail

equalsback to summary
public boolean equals(final Object o)

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
o: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
getback to summary
public T get()

Implements org.glassfish.tyrus.core.collection.Value.get.

Doc from org.glassfish.tyrus.core.collection.Value.get.

Get the stored value.

Returns:T

stored value.

Annotations
@Override
hashCodeback 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
isInitializedback to summary
public boolean isInitialized()

Implements org.glassfish.tyrus.core.collection.LazyValue.isInitialized.

Doc from org.glassfish.tyrus.core.collection.LazyValue.isInitialized.

Check if the lazy value has been initialized already (i.e. its get() method has already been called previously) or not.

Returns:boolean

true if the lazy value has already been initialized, false otherwise.

Annotations
@Override
toStringback 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