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

public Class DuplicatePostProcessor

extends Object
implements PopulatorPostProcessor
Class Inheritance
All Implemented Interfaces
org.glassfish.hk2.api.PopulatorPostProcessor
Annotations
@PerLookup
Imports
java.util.HashSet, .Set, org.glassfish.hk2.api.Descriptor, .DescriptorType, .Filter, .IndexedFilter, .PerLookup, .PopulatorPostProcessor, .ServiceLocator
This post-processor removes duplicate descriptors from the set of descriptors being added to the service registry.

It is often the case when using a classpath that the same jar file can appear on the path more than once. For example this is often done when patching. However, if this jar contains HK2 descriptor files in it, that can mean duplicate services that are not intended to be duplicated. This service removes all duplicate descriptors from the set to be added to HK2

Author
jwells

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DuplicatePostProcessor.ImplOnlyKey

Key use for implementation only (along with descriptor type, otherwise factories eliminate themselves)

Field Summary

Modifier and TypeField and Description
private final HashSet<DuplicatePostProcessor.ImplOnlyKey>
implOnlyDupSet

private final DuplicatePostProcessorMode
mode

private final HashSet<DescriptorImpl>
strictDupSet

Constructor Summary

AccessConstructor and Description
public
DuplicatePostProcessor()

Creates a DuplicatePostProcessor with the STRICT mode for determining duplicates

public
DuplicatePostProcessor(DuplicatePostProcessorMode mode)

Creates a DuplicatePostProcessor with the

Method Summary

Modifier and TypeMethod and Description
public DuplicatePostProcessorMode

Returns:

The mode
getMode()

Returns the mode of this DuplicatePostProcessorMode of this processor

private DescriptorImpl
implementationOnly(ServiceLocator serviceLocator, final DescriptorImpl descriptorImpl)

public DescriptorImpl
process(ServiceLocator serviceLocator, DescriptorImpl descriptorImpl)

Implements org.glassfish.hk2.api.PopulatorPostProcessor.process.

This method can be used to alter the descriptor read in. It can also add descriptors, or remove the descriptor (by returning null).

private DescriptorImpl
strict(ServiceLocator serviceLocator, DescriptorImpl descriptorImpl)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

implOnlyDupSetback to summary
private final HashSet<DuplicatePostProcessor.ImplOnlyKey> implOnlyDupSet
modeback to summary
private final DuplicatePostProcessorMode mode
strictDupSetback to summary
private final HashSet<DescriptorImpl> strictDupSet

Constructor Detail

DuplicatePostProcessorback to summary
public DuplicatePostProcessor()

Creates a DuplicatePostProcessor with the STRICT mode for determining duplicates

DuplicatePostProcessorback to summary
public DuplicatePostProcessor(DuplicatePostProcessorMode mode)

Creates a DuplicatePostProcessor with the

Method Detail

getModeback to summary
public DuplicatePostProcessorMode getMode()

Returns the mode of this DuplicatePostProcessorMode of this processor

Returns:DuplicatePostProcessorMode

The mode

implementationOnlyback to summary
private DescriptorImpl implementationOnly(ServiceLocator serviceLocator, final DescriptorImpl descriptorImpl)
processback to summary
public DescriptorImpl process(ServiceLocator serviceLocator, DescriptorImpl descriptorImpl)

Implements org.glassfish.hk2.api.PopulatorPostProcessor.process.

Doc from org.glassfish.hk2.api.PopulatorPostProcessor.process.

This method can be used to alter the descriptor read in. It can also add descriptors, or remove the descriptor (by returning null). Any alterations made to the descriptor passed in will remain in effect.

Annotations
@Override
strictback to summary
private DescriptorImpl strict(ServiceLocator serviceLocator, DescriptorImpl descriptorImpl)
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
org.glassfish.hk2.utilities back to summary

private final Class DuplicatePostProcessor.ImplOnlyKey

extends Object
Class Inheritance
  • java.lang.Object
  • org.glassfish.hk2.utilities.DuplicatePostProcessor.ImplOnlyKey
Key use for implementation only (along with descriptor type, otherwise factories eliminate themselves)
Author
jwells

Field Summary

Modifier and TypeField and Description
private final int
hash

private final String
impl

private final DescriptorType
type

Constructor Summary

AccessConstructor and Description
private
ImplOnlyKey(Descriptor desc)

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

hashback to summary
private final int hash
implback to summary
private final String impl
typeback to summary
private final DescriptorType type

Constructor Detail

ImplOnlyKeyback to summary
private ImplOnlyKey(Descriptor desc)

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