hk2 4.0.1 · org.glassfish.hk2.utilities.ClasspathDescriptorFileFinder

Field Summary

Modifier and Type	Field and Description
private final ClassLoader	classLoader
private static final boolean	DEBUG_DESCRIPTOR_FINDER
private static final String	DEBUG_DESCRIPTOR_FINDER_PROPERTY
private static final String	DEFAULT_NAME
private final List<String>	identifiers
private final String[]	names
private final String	resourceBase

Constructor Summary

Access	Constructor and Description
public	ClasspathDescriptorFileFinder() If this constructor is used then HK2 descriptor files will be found by looking in the classpath of the process.
public	ClasspathDescriptorFileFinder(ClassLoader May not be null and must be the classloader to use when searching for HK2 descriptor files cl) This constructor can be used to select the particular classloader to search for HK2 descriptor files.
public	ClasspathDescriptorFileFinder(ClassLoader May not be null and must be the classloader to use when searching for HK2 descriptor files cl, String... May not be null and must be the name of the files to search for in the META-INF/hk2-locator directory names) This constructor can be used to select the particular classloader to search for HK2 descriptor files.
public	ClasspathDescriptorFileFinder(String The directory of locator files, the class loader will search from resourceBase, ClassLoader May not be null and must be the classloader to use when searching for HK2 descriptor files cl) This constructor can be used to select the particular classloader to search for all files from the given locator directory.
private	ClasspathDescriptorFileFinder(String resourceBase, ClassLoader cl, String... names)

Method Summary

Modifier and Type	Method and Description
public List<InputStream>	findDescriptorFiles() Implements org.glassfish.hk2.api.DescriptorFileFinder.findDescriptorFiles. Simple implementation of the findDescriptorFiles which does a simple getResources on the classloader in order to find the hk2 descriptor files
public List<String>	getDescriptorFileInformation() Implements org.glassfish.hk2.api.DescriptorFileFinderInformation.getDescriptorFileInformation. This list must have the same cardinality as `DescriptorFileFinder#findDescriptorFiles()`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

classLoader	back to summary
private final ClassLoader classLoader

DEBUG_DESCRIPTOR_FINDER	back to summary
private static final boolean DEBUG_DESCRIPTOR_FINDER

DEBUG_DESCRIPTOR_FINDER_PROPERTY	back to summary
private static final String DEBUG_DESCRIPTOR_FINDER_PROPERTY

DEFAULT_NAME	back to summary
private static final String DEFAULT_NAME

identifiers	back to summary
private final List<String> identifiers

names	back to summary
private final String[] names

resourceBase	back to summary
private final String resourceBase

Constructor Detail

ClasspathDescriptorFileFinder	back to summary
public ClasspathDescriptorFileFinder() If this constructor is used then HK2 descriptor files will be found by looking in the classpath of the process. The classloader used will be the classloader for this class itself. The names of the files found will be META-INF/hk2-locator/default. This is most commonly used when using HK2 from a stand-alone client in which all the JAR files are on a single classpath

ClasspathDescriptorFileFinder

back to summary

public ClasspathDescriptorFileFinder()

If this constructor is used then HK2 descriptor files will be found by looking in the classpath of the process. The classloader used will be the classloader for this class itself. The names of the files found will be META-INF/hk2-locator/default.

This is most commonly used when using HK2 from a stand-alone client in which all the JAR files are on a single classpath

ClasspathDescriptorFileFinder	back to summary
public ClasspathDescriptorFileFinder(ClassLoader cl) This constructor can be used to select the particular classloader to search for HK2 descriptor files. The names of the the files found in this classloader will be META-INF/hk2-locator/default. This is commonly used in more complex classloading scenarios where the HK2 descriptor files are not necessarily on the system classpath. Parameters cl:ClassLoader May not be null and must be the classloader to use when searching for HK2 descriptor files

ClasspathDescriptorFileFinder

back to summary

public ClasspathDescriptorFileFinder(ClassLoader cl)

This constructor can be used to select the particular classloader to search for HK2 descriptor files. The names of the the files found in this classloader will be META-INF/hk2-locator/default.

This is commonly used in more complex classloading scenarios where the HK2 descriptor files are not necessarily on the system classpath.

Parameters

cl:ClassLoader: May not be null and must be the classloader to use when searching for HK2 descriptor files

ClasspathDescriptorFileFinder	back to summary
public ClasspathDescriptorFileFinder(ClassLoader cl, String... names) This constructor can be used to select the particular classloader to search for HK2 descriptor files. The names of the the files found in this classloader will be META-INF/hk2-locator/name. Parameters cl:ClassLoader May not be null and must be the classloader to use when searching for HK2 descriptor files names:String[] May not be null and must be the name of the files to search for in the META-INF/hk2-locator directory

ClasspathDescriptorFileFinder

back to summary

public ClasspathDescriptorFileFinder(ClassLoader cl, String... names)

This constructor can be used to select the particular classloader to search for HK2 descriptor files. The names of the the files found in this classloader will be META-INF/hk2-locator/name.

Parameters

cl:ClassLoader: May not be null and must be the classloader to use when searching for HK2 descriptor files
names:String[]: May not be null and must be the name of the files to search for in the META-INF/hk2-locator directory

ClasspathDescriptorFileFinder	back to summary
public ClasspathDescriptorFileFinder(String resourceBase, ClassLoader cl) This constructor can be used to select the particular classloader to search for all files from the given locator directory. By using this constructor, all files in the given directory are assumed to be HK2 descriptor files. Parameters resourceBase:String The directory of locator files, the class loader will search from cl:ClassLoader May not be null and must be the classloader to use when searching for HK2 descriptor files

ClasspathDescriptorFileFinder

back to summary

public ClasspathDescriptorFileFinder(String resourceBase, ClassLoader cl)

This constructor can be used to select the particular classloader to search for all files from the given locator directory. By using this constructor, all files in the given directory are assumed to be HK2 descriptor files.

Parameters

resourceBase:String: The directory of locator files, the class loader will search from
cl:ClassLoader: May not be null and must be the classloader to use when searching for HK2 descriptor files

ClasspathDescriptorFileFinder	back to summary
private ClasspathDescriptorFileFinder(String resourceBase, ClassLoader cl, String... names)

Method Detail

findDescriptorFiles	back to summary
public List<InputStream> findDescriptorFiles() throws IOException Implements org.glassfish.hk2.api.DescriptorFileFinder.findDescriptorFiles. Simple implementation of the findDescriptorFiles which does a simple getResources on the classloader in order to find the hk2 descriptor files Annotations @Override Exceptions IOException: Doc from org.glassfish.hk2.api.DescriptorFileFinder.findDescriptorFiles. If there was an error finding the hk2 inhabitant files

findDescriptorFiles

back to summary

public List<InputStream> findDescriptorFiles() throws IOException

Implements org.glassfish.hk2.api.DescriptorFileFinder.findDescriptorFiles.

Simple implementation of the findDescriptorFiles which does a simple getResources on the classloader in order to find the hk2 descriptor files

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.hk2.api.DescriptorFileFinder.findDescriptorFiles.

If there was an error finding the hk2 inhabitant files

getDescriptorFileInformation back to summary

getDescriptorFileInformation	back to summary
public List<String> getDescriptorFileInformation() Implements org.glassfish.hk2.api.DescriptorFileFinderInformation.getDescriptorFileInformation. Doc from org.glassfish.hk2.api.DescriptorFileFinderInformation.getDescriptorFileInformation. This list must have the same cardinality as `DescriptorFileFinder#findDescriptorFiles()`. The Strings returned from this list must give identifying information about the InputStream with the same index. For example, if the InputStream is from a `java.net.URL` then the toString of the URL would be appropriate. If the InputStream is from a `java.io.File` then the Absolute path to that file might be appropriate Annotations @Override

public List<String> getDescriptorFileInformation()

Implements org.glassfish.hk2.api.DescriptorFileFinderInformation.getDescriptorFileInformation.

Doc from org.glassfish.hk2.api.DescriptorFileFinderInformation.getDescriptorFileInformation.

This list must have the same cardinality as DescriptorFileFinder#findDescriptorFiles(). The Strings returned from this list must give identifying information about the InputStream with the same index. For example, if the InputStream is from a java.net.URL then the toString of the URL would be appropriate. If the InputStream is from a java.io.File then the Absolute path to that file might be appropriate

Annotations

@Override

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.

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.

public Class ClasspathDescriptorFileFinder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail