Top Description Fields Constructors Methods
org.glassfish.hk2.utilities

public Class FactoryDescriptorsImpl

extends Object
implements FactoryDescriptors
Class Inheritance
All Implemented Interfaces
org.glassfish.hk2.api.FactoryDescriptors
Imports
org.glassfish.hk2.api.Descriptor, .DescriptorType, .Factory, .FactoryDescriptors

This is an implementation of FactoryDescriptors that can be used by hk2 uses when creating descriptors that describe a Factory
Author
jwells

Field Summary

Modifier and TypeField and Description
private final Descriptor
private final Descriptor

Constructor Summary

AccessConstructor and Description
public
FactoryDescriptorsImpl(Descriptor
A description of the factory itself as an hk2 service. May not be null. Must have DescriptorType of DescriptorType#CLASS. One of the contracts must be Factory
asService
,
Descriptor
A description of the provide method of the factory. Must have DescriptorType of DescriptorType#PROVIDE_METHOD. May not be null
asProvideMethod
)

This creates a descriptor pair describing a Factory and the associated Factory#provide() method

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public Descriptor
getFactoryAsAFactory()

Implements org.glassfish.hk2.api.FactoryDescriptors.getFactoryAsAFactory.

This returns the factory as a factory for some other type.

public Descriptor
getFactoryAsAService()

Implements org.glassfish.hk2.api.FactoryDescriptors.getFactoryAsAService.

This returns the factory as a service itself.

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

asProvideMethodback to summary
private final Descriptor asProvideMethod
asServiceback to summary
private final Descriptor asService

Constructor Detail

FactoryDescriptorsImplback to summary
public FactoryDescriptorsImpl(Descriptor asService, Descriptor asProvideMethod)

This creates a descriptor pair describing a Factory and the associated Factory#provide() method

Parameters
asService:Descriptor

A description of the factory itself as an hk2 service. May not be null. Must have DescriptorType of DescriptorType#CLASS. One of the contracts must be Factory

asProvideMethod:Descriptor

A description of the provide method of the factory. Must have DescriptorType of DescriptorType#PROVIDE_METHOD. May not be null

Exceptions
IllegalArgumentException:
if the descriptors are not of the proper type

Method Detail

equalsback to summary
public boolean equals(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.

Annotations
@Override
getFactoryAsAFactoryback to summary
public Descriptor getFactoryAsAFactory()

Implements org.glassfish.hk2.api.FactoryDescriptors.getFactoryAsAFactory.

Doc from org.glassfish.hk2.api.FactoryDescriptors.getFactoryAsAFactory.

This returns the factory as a factory for some other type. The implementation class should contain the implementation class of the factory service. If the implementation class returned from this does not match the implementation class returned from getFactoryAsAService an error will occur. The contracts, name and qualifiers should represent the type returned from the provide method of the factory. The descriptor type must be DescriptorType#PROVIDE_METHOD since this descriptor is describing the factory as a factory, not as a service.

Annotations
@Override
getFactoryAsAServiceback to summary
public Descriptor getFactoryAsAService()

Implements org.glassfish.hk2.api.FactoryDescriptors.getFactoryAsAService.

Doc from org.glassfish.hk2.api.FactoryDescriptors.getFactoryAsAService.

This returns the factory as a service itself. The advertised contracts must contain the implementation class of the factory and the Factory. The descriptor type must be DescriptorType#CLASS since this descriptor is describing the factory itself.

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.
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.

Annotations
@Override