com.mikepenz.aboutlibraries

Class Libs

java.lang.Object

com.mikepenz.aboutlibraries.Libs

public class Libs
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Libs.ActivityStyle
static class	Libs.LibraryFields
static class	Libs.SpecialButton

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_COLORS
static java.lang.String	BUNDLE_STYLE
static java.lang.String	BUNDLE_THEME
static java.lang.String	BUNDLE_TITLE

Constructor Summary

Constructors

Constructor and Description
Libs(android.content.Context context)
Libs(android.content.Context context, java.lang.String[] fields)

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<Library>	findInExternalLibrary(java.lang.String searchTerm, boolean idOnly, int limit)
java.util.ArrayList<Library>	findInInternalLibrary(java.lang.String searchTerm, boolean idOnly, int limit)
java.util.ArrayList<Library>	findLibrary(java.lang.String searchTerm, int limit) Find a library by a searchTerm (Limit the results if there are more than one)
java.util.List<Library>	getAutoDetectedLibraries(android.content.Context ctx, boolean checkCachedDetection) Get all autoDetected Libraries
java.util.HashMap<java.lang.String,java.lang.String>	getCustomVariables(android.content.Context ctx, java.lang.String libraryName)
java.util.ArrayList<Library>	getExternLibraries() Get all extern available Libraries
java.util.ArrayList<Library>	getInternLibraries() Get all intern available Libraries
java.util.ArrayList<Library>	getLibraries() Get all available Libraries
Library	getLibrary(java.lang.String libraryName) Get a library by its name (the name must be equal)
License	getLicense(java.lang.String licenseName)
java.util.ArrayList<License>	getLicenses() Get all available licenses
java.lang.String	getStringResourceByName(android.content.Context ctx, java.lang.String aString)
java.lang.String	insertVariables(java.lang.String insertInto, java.util.HashMap<java.lang.String,java.lang.String> variables)
void	modifyLibraries(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> modifications)
java.util.ArrayList<Library>	prepareLibraries(android.content.Context ctx, java.lang.String[] internalLibraries, java.lang.String[] excludeLibraries, boolean autoDetect, boolean checkCachedDetection, boolean sort) This will summarize all libraries and elimate duplicates
static java.lang.String[]	toStringArray(java.lang.reflect.Field[] fields) A helper method to get a String[] out of a fieldArray

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_THEME

public static final java.lang.String BUNDLE_THEME

See Also:

Constant Field Values

BUNDLE_TITLE

public static final java.lang.String BUNDLE_TITLE

See Also:

Constant Field Values

BUNDLE_STYLE

public static final java.lang.String BUNDLE_STYLE

See Also:

Constant Field Values

BUNDLE_COLORS

public static final java.lang.String BUNDLE_COLORS

See Also:

Constant Field Values

Constructor Detail

Libs

public Libs(android.content.Context context)

Libs

public Libs(android.content.Context context,
            java.lang.String[] fields)

Method Detail

toStringArray

public static java.lang.String[] toStringArray(java.lang.reflect.Field[] fields)

A helper method to get a String[] out of a fieldArray

Parameters:

fields - R.strings.class.getFields()

Returns:

a String[] with the string ids we need

prepareLibraries

public java.util.ArrayList<Library> prepareLibraries(android.content.Context ctx,
                                                     java.lang.String[] internalLibraries,
                                                     java.lang.String[] excludeLibraries,
                                                     boolean autoDetect,
                                                     boolean checkCachedDetection,
                                                     boolean sort)

This will summarize all libraries and elimate duplicates

Parameters:

internalLibraries - the String[] with the internalLibraries (if set manual)

excludeLibraries - the String[] with the libs to be excluded

autoDetect - defines if the libraries should be resolved by their classpath (if possible)

checkCachedDetection - defines if we should check the cached autodetected libraries (per version) (default: enabled)

sort - defines if the array should be sorted

Returns:

the summarized list of included Libraries

getAutoDetectedLibraries

public java.util.List<Library> getAutoDetectedLibraries(android.content.Context ctx,
                                                        boolean checkCachedDetection)

Get all autoDetected Libraries

Parameters:

ctx - the current context

checkCachedDetection - defines if we should check the cached autodetected libraries (per version) (default: enabled)

Returns:

an ArrayList Library with all found libs by their classpath

getInternLibraries

public java.util.ArrayList<Library> getInternLibraries()

Get all intern available Libraries

Returns:

an ArrayList Library with all available internLibraries

getExternLibraries

public java.util.ArrayList<Library> getExternLibraries()

Get all extern available Libraries

Returns:

an ArrayList Library with all available externLibraries

getLicenses

public java.util.ArrayList<License> getLicenses()

Get all available licenses

Returns:

an ArrayLIst License with all available Licenses

getLibraries

public java.util.ArrayList<Library> getLibraries()

Get all available Libraries

Returns:

an ArrayList Library with all available Libraries

getLibrary

public Library getLibrary(java.lang.String libraryName)

Get a library by its name (the name must be equal)

Parameters:

libraryName - the name of the lib (NOT case sensitiv) or the real name of the lib (this is the name used for github)

Returns:

the found library or null

findLibrary

public java.util.ArrayList<Library> findLibrary(java.lang.String searchTerm,
                                                int limit)

Find a library by a searchTerm (Limit the results if there are more than one)

Parameters:

searchTerm - the term which is in the libs name (NOT case sensitiv) or the real name of the lib (this is the name used for github)

limit - -1 for all results or smaller 0 for a limitted result

Returns:

an ArrayList Library with the found internLibraries

findInInternalLibrary

public java.util.ArrayList<Library> findInInternalLibrary(java.lang.String searchTerm,
                                                          boolean idOnly,
                                                          int limit)

Parameters:

searchTerm -

idOnly -

limit -

Returns:

findInExternalLibrary

public java.util.ArrayList<Library> findInExternalLibrary(java.lang.String searchTerm,
                                                          boolean idOnly,
                                                          int limit)

Parameters:

searchTerm -

idOnly -

limit -

Returns:

getLicense

public License getLicense(java.lang.String licenseName)

Parameters:

licenseName -

Returns:

getCustomVariables

public java.util.HashMap<java.lang.String,java.lang.String> getCustomVariables(android.content.Context ctx,
                                                                               java.lang.String libraryName)

Parameters:

libraryName -

Returns:

insertVariables

public java.lang.String insertVariables(java.lang.String insertInto,
                                        java.util.HashMap<java.lang.String,java.lang.String> variables)

getStringResourceByName

public java.lang.String getStringResourceByName(android.content.Context ctx,
                                                java.lang.String aString)

modifyLibraries

public void modifyLibraries(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> modifications)

Parameters:

modifications -