com.atlassian.plugin.spring.scanner.runtime.impl.util

Class AnnotationIndexReader

java.lang.Object

com.atlassian.plugin.spring.scanner.runtime.impl.util.AnnotationIndexReader

public class AnnotationIndexReader
extends Object

A utility class to read index files from a classloader or bundle. Can handle reading a single index file, or concating multiple index files based on the currently running product.

Constructor Summary

Constructors

Constructor and Description
AnnotationIndexReader()

Method Summary

Modifier and Type	Method and Description
static Iterable<String>	getIndexFilesForProfiles(String[] profileNames, String indexFileName)
static List<String>	readAllIndexFilesForProduct(String resourceFile, org.osgi.framework.Bundle bundle, org.osgi.framework.BundleContext bundleContext) Read both the cross-product file and the product-specific file for the currently running product from the bundle and returns their lines as a single list.
static List<String>	readIndexFile(String resourceFile, org.osgi.framework.Bundle bundle) Read a file from a bundle and return the list of lines of the file.
static List<String>	readIndexFile(URL url)
static Properties	readPropertiesFile(URL url)
static String[]	splitProfiles(String profiles)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationIndexReader

public AnnotationIndexReader()

Method Detail

readIndexFile

public static List<String> readIndexFile(String resourceFile,
                                         org.osgi.framework.Bundle bundle)

Read a file from a bundle and return the list of lines of the file.

Parameters:

resourceFile - the path to the file in the bundle

bundle - the bundle to read from

Returns:

the lines in the file

readAllIndexFilesForProduct

public static List<String> readAllIndexFilesForProduct(String resourceFile,
                                                       org.osgi.framework.Bundle bundle,
                                                       org.osgi.framework.BundleContext bundleContext)

Read both the cross-product file and the product-specific file for the currently running product from the bundle and returns their lines as a single list.

Parameters:

resourceFile - the path to the cross-product file in the bundle

bundle - the bundle to read from

bundleContext - the bundle context used to determine the running product

Returns:

the lines in the file

readIndexFile

public static List<String> readIndexFile(URL url)

readPropertiesFile

public static Properties readPropertiesFile(URL url)

splitProfiles

public static String[] splitProfiles(String profiles)

getIndexFilesForProfiles

public static Iterable<String> getIndexFilesForProfiles(String[] profileNames,
                                                        String indexFileName)