LibsBuilder (library API)

java.lang.Object
- com.mikepenz.aboutlibraries.LibsBuilder

All Implemented Interfaces:: java.io.Serializable

public class LibsBuilder
extends java.lang.Object
implements java.io.Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`aboutAppName`
`java.lang.String`	`aboutAppSpecial1`
`java.lang.String`	`aboutAppSpecial1Description`
`java.lang.String`	`aboutAppSpecial2`
`java.lang.String`	`aboutAppSpecial2Description`
`java.lang.String`	`aboutAppSpecial3`
`java.lang.String`	`aboutAppSpecial3Description`
`java.lang.String`	`aboutDescription`
`java.lang.Boolean`	`aboutShowIcon`
`java.lang.Boolean`	`aboutShowVersion`
`java.lang.Boolean`	`aboutShowVersionCode`
`java.lang.Boolean`	`aboutShowVersionName`
`java.lang.String`	`aboutVersionString`
`Colors`	`activityColor`
`Libs.ActivityStyle`	`activityStyle`
`java.lang.Integer`	`activityTheme`
`java.lang.String`	`activityTitle`
`java.lang.Boolean`	`autoDetect`
`java.lang.Boolean`	`checkCachedDetection`
`java.lang.String[]`	`excludeLibraries`
`java.lang.String[]`	`fields`
`java.lang.String[]`	`internalLibraries`
`java.util.Comparator<Library>`	`libraryComparator`
`java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>`	`libraryModification`
`LibTaskExecutor`	`libTaskExecutor`
`java.lang.Class`	`ownLibsActivityClass`
`java.lang.Boolean`	`showLicense`
`java.lang.Boolean`	`showLicenseDialog`
`boolean`	`showLoadingProgress`
`java.lang.Boolean`	`showVersion`
`java.lang.Boolean`	`sort`

Constructor Summary

Constructors
Constructor and Description

LibsBuilder()

Constructors
Constructor and Description
`LibsBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activity(android.content.Context ctx)` activity() method to start the application
`FastAdapter`	`adapter(android.content.Context context)` builder to build an adapter out of the given information ;D
`LibsFragment`	`fragment()` supportFragment() method to build and create the fragment with the set params
`android.content.Intent`	`intent(android.content.Context ctx)` intent() method to build and create the intent with the set params
`android.content.Intent`	`intent(android.content.Context ctx, java.lang.Class clazz)` intent() method to build and create the intent with the set params
`void`	`start(android.content.Context ctx)` start() method to start the application
`LibsSupportFragment`	`supportFragment()` supportFragment() method to build and create the fragment with the set params
`LibsBuilder`	`withAboutAppName(java.lang.String aboutAppName)` Builder method to enable the display and set the text of the application name in the about this app view
`LibsBuilder`	`withAboutDescription(java.lang.String aboutDescription)` Builder method to enable the display and set the text of the application description as about this app view
`LibsBuilder`	`withAboutIconShown(boolean aboutShowIcon)` Builder method to enable the display of the application icon as about this app view
`LibsBuilder`	`withAboutSpecial1(java.lang.String aboutAppSpecial1)`
`LibsBuilder`	`withAboutSpecial1Description(java.lang.String aboutAppSpecial1Description)`
`LibsBuilder`	`withAboutSpecial2(java.lang.String aboutAppSpecial2)`
`LibsBuilder`	`withAboutSpecial2Description(java.lang.String aboutAppSpecial2Description)`
`LibsBuilder`	`withAboutSpecial3(java.lang.String aboutAppSpecial3)`
`LibsBuilder`	`withAboutSpecial3Description(java.lang.String aboutAppSpecial3Description)`
`LibsBuilder`	`withAboutVersionShown(boolean aboutShowVersion)` Builder method to enable the display of the application version name and code as about this app view
`LibsBuilder`	`withAboutVersionShownCode(boolean aboutShowVersion)` Builder method to enable the display of the application version code as about this app view
`LibsBuilder`	`withAboutVersionShownName(boolean aboutShowVersion)` Builder method to enable the display of the application version name as about this app view
`LibsBuilder`	`withAboutVersionString(java.lang.String aboutVersionString)` Builder method to enable the display and set the text of the application version in the about this app view
`LibsBuilder`	`withActivityColor(Colors activityColor)` Builder method to set the ActivityColor
`LibsBuilder`	`withActivityStyle(Libs.ActivityStyle libraryStyle)` Builder method to set the ActivityStyle
`LibsBuilder`	`withActivityTheme(int activityTheme)` Builder method to set the activity theme
`LibsBuilder`	`withActivityTitle(java.lang.String activityTitle)` Builder method to set the ActivityTitle
`LibsBuilder`	`withAutoDetect(boolean autoDetect)` Builder method to disable autoDetect (default: enabled)
`LibsBuilder`	`withCheckCachedDetection(boolean checkCachedDetection)` Builder method to disable checking the cached autodetected libraries (per version) (default: enabled)
`LibsBuilder`	`withExcludedLibraries(java.lang.String... excludeLibraries)` Builder method to exclude specific libraries
`LibsBuilder`	`withFields(java.lang.reflect.Field[] fields)` Builder method to pass the R.string.class.getFields() array to the fragment/activity so we can also include all ressources which are within libraries or your app.
`LibsBuilder`	`withFields(java.lang.String... fields)` Builder method to pass the Libs.toStringArray(R.string.class.getFields()) array to the fragment/activity so we can also include all ressources which are within libraries or your app.
`LibsBuilder`	`withLayoutAnimationController(android.view.animation.LayoutAnimationController layoutAnimationController)` Builder method to set the LayoutAnimationController for the RecyclerView
`LibsBuilder`	`withLibraries(java.lang.String... libraries)` Builder method to pass manual libraries (libs which are not autoDetected)
`LibsBuilder`	`withLibraryComparator(java.util.Comparator<Library> libraryComparator)` Builder method to enable custom sorting of the libraries (default: null)
`LibsBuilder`	`withLibraryModification(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> libraryModification)` Builder method to modify specific libraries.
`LibsBuilder`	`withLibraryModification(java.lang.String library, Libs.LibraryFields modificationKey, java.lang.String modificationValue)` Builder helper method to set modifications for specific libraries
`LibsBuilder`	`withLibsRecyclerViewListener(LibsConfiguration.LibsRecyclerViewListener recyclerViewListener)` Builder method to set the LibsRecyclerViewListener for the AboutLibraries recyclerView elements
`LibsBuilder`	`withLibTaskCallback(LibTaskCallback libTaskCallback)` Builder method to define a custom callback which is invoked every time the LibraryTask gets executed.
`LibsBuilder`	`withLibTaskExecutor(LibTaskExecutor libTaskExecutor)` Builder method to define a custom Thread Executor for asynchronous operations
`LibsBuilder`	`withLicenseDialog(boolean showLicenseDialog)` Builder method to disable the license display as dialog (default: enabled)
`LibsBuilder`	`withLicenseShown(boolean showLicense)` Builder method to enable the license display (default: disabled)
`LibsBuilder`	`withListener(LibsConfiguration.LibsListener libsListener)` Builder method to set the LibsListener for the AboutLibraries actions
`LibsBuilder`	`withOwnLibsActivityClass(java.lang.Class clazz)` Builder method to pass the an own LibsActivity.
`LibsBuilder`	`withShowLoadingProgress(boolean showLoadingProgress)` Builder method to allow you to disable the automatically shown loading progressBar while the libraries are loading
`LibsBuilder`	`withSortEnabled(boolean sort)` Builder method to disable sort (default: enabled)
`LibsBuilder`	`withUiListener(LibsConfiguration.LibsUIListener uiListener)` Builder method to set the LibsUIListener for the AboutLibraries view to hook into the view creation
`LibsBuilder`	`withVersionShown(boolean showVersion)` Builder method to hide the version number (default: enabled)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fields
```
public java.lang.String[] fields
```
  - internalLibraries
```
public java.lang.String[] internalLibraries
```
  - excludeLibraries
```
public java.lang.String[] excludeLibraries
```
  - autoDetect
```
public java.lang.Boolean autoDetect
```
  - checkCachedDetection
```
public java.lang.Boolean checkCachedDetection
```
  - sort
```
public java.lang.Boolean sort
```
  - libraryComparator
```
public java.util.Comparator<Library> libraryComparator
```
  - showLicense
```
public java.lang.Boolean showLicense
```
  - showLicenseDialog
```
public java.lang.Boolean showLicenseDialog
```
  - showVersion
```
public java.lang.Boolean showVersion
```
  - showLoadingProgress
```
public boolean showLoadingProgress
```
  - aboutShowIcon
```
public java.lang.Boolean aboutShowIcon
```
  - aboutVersionString
```
public java.lang.String aboutVersionString
```
  - aboutAppName
```
public java.lang.String aboutAppName
```
  - aboutShowVersion
```
public java.lang.Boolean aboutShowVersion
```
  - aboutDescription
```
public java.lang.String aboutDescription
```
  - aboutShowVersionName
```
public java.lang.Boolean aboutShowVersionName
```
  - aboutShowVersionCode
```
public java.lang.Boolean aboutShowVersionCode
```
  - aboutAppSpecial1
```
public java.lang.String aboutAppSpecial1
```
  - aboutAppSpecial1Description
```
public java.lang.String aboutAppSpecial1Description
```
  - aboutAppSpecial2
```
public java.lang.String aboutAppSpecial2
```
  - aboutAppSpecial2Description
```
public java.lang.String aboutAppSpecial2Description
```
  - aboutAppSpecial3
```
public java.lang.String aboutAppSpecial3
```
  - aboutAppSpecial3Description
```
public java.lang.String aboutAppSpecial3Description
```
  - activityTheme
```
public java.lang.Integer activityTheme
```
  - activityTitle
```
public java.lang.String activityTitle
```
  - activityColor
```
public Colors activityColor
```
  - activityStyle
```
public Libs.ActivityStyle activityStyle
```
  - libTaskExecutor
```
public LibTaskExecutor libTaskExecutor
```
  - libraryModification
```
public java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> libraryModification
```
  - ownLibsActivityClass
```
public java.lang.Class ownLibsActivityClass
```
- Constructor Detail
  - LibsBuilder
```
public LibsBuilder()
```
- Method Detail
  - withOwnLibsActivityClass
```
public LibsBuilder withOwnLibsActivityClass(java.lang.Class clazz)
```
    Builder method to pass the an own LibsActivity.
    
    Parameters:
    
    clazz - Class
    
    Returns:
    
    this
  - withFields
```
public LibsBuilder withFields(java.lang.reflect.Field[] fields)
```
    Builder method to pass the R.string.class.getFields() array to the fragment/activity so we can also include all ressources which are within libraries or your app.
    
    Parameters:
    
    fields - R.string.class.getFields()
    
    Returns:
    
    this
  - withFields
```
public LibsBuilder withFields(java.lang.String... fields)
```
    Builder method to pass the Libs.toStringArray(R.string.class.getFields()) array to the fragment/activity so we can also include all ressources which are within libraries or your app.
    
    Parameters:
    
    fields - Libs.toStringArray(R.string.class.getFields())
    
    Returns:
    
    this
  - withLibraries
```
public LibsBuilder withLibraries(java.lang.String... libraries)
```
    Builder method to pass manual libraries (libs which are not autoDetected)
    
    Parameters:
    
    libraries - the identifiers of the manual added libraries
    
    Returns:
    
    this
  - withExcludedLibraries
```
public LibsBuilder withExcludedLibraries(java.lang.String... excludeLibraries)
```
    Builder method to exclude specific libraries
    
    Parameters:
    
    excludeLibraries - the identifiers of the libraries which should be excluded
    
    Returns:
    
    this
  - withAutoDetect
```
public LibsBuilder withAutoDetect(boolean autoDetect)
```
    Builder method to disable autoDetect (default: enabled)
    
    Parameters:
    
    autoDetect - enabled or disabled
    
    Returns:
    
    this
  - withCheckCachedDetection
```
public LibsBuilder withCheckCachedDetection(boolean checkCachedDetection)
```
    Builder method to disable checking the cached autodetected libraries (per version) (default: enabled)
    
    Parameters:
    
    checkCachedDetection - enabled or disabled
    
    Returns:
    
    this
  - withSortEnabled
```
public LibsBuilder withSortEnabled(boolean sort)
```
    Builder method to disable sort (default: enabled)
    
    Parameters:
    
    sort - enabled or disabled
    
    Returns:
    
    this
  - withLibraryComparator
```
public LibsBuilder withLibraryComparator(java.util.Comparator<Library> libraryComparator)
```
    Builder method to enable custom sorting of the libraries (default: null)
    
    Parameters:
    
    libraryComparator - comparator to customize the sorting of the libraries
    
    Returns:
    
    this
  - withLicenseShown
```
public LibsBuilder withLicenseShown(boolean showLicense)
```
    Builder method to enable the license display (default: disabled)
    
    Parameters:
    
    showLicense - enabled or disabled
    
    Returns:
    
    this
  - withLicenseDialog
```
public LibsBuilder withLicenseDialog(boolean showLicenseDialog)
```
    Builder method to disable the license display as dialog (default: enabled)
    
    Parameters:
    
    showLicenseDialog - enabled or disabled
    
    Returns:
    
    this
  - withVersionShown
```
public LibsBuilder withVersionShown(boolean showVersion)
```
    Builder method to hide the version number (default: enabled)
    
    Parameters:
    
    showVersion - enabled or disabled
    
    Returns:
    
    this
  - withAboutIconShown
```
public LibsBuilder withAboutIconShown(boolean aboutShowIcon)
```
    Builder method to enable the display of the application icon as about this app view
    
    Parameters:
    
    aboutShowIcon - enabled or disabled
    
    Returns:
    
    this
  - withAboutVersionShown
```
public LibsBuilder withAboutVersionShown(boolean aboutShowVersion)
```
    Builder method to enable the display of the application version name and code as about this app view
    
    Parameters:
    
    aboutShowVersion - enabled or disabled
    
    Returns:
    
    this
  - withAboutVersionShownName
```
public LibsBuilder withAboutVersionShownName(boolean aboutShowVersion)
```
    Builder method to enable the display of the application version name as about this app view
    
    Parameters:
    
    aboutShowVersion - enabled or disabled
    
    Returns:
    
    this
  - withAboutVersionShownCode
```
public LibsBuilder withAboutVersionShownCode(boolean aboutShowVersion)
```
    Builder method to enable the display of the application version code as about this app view
    
    Parameters:
    
    aboutShowVersion - enabled or disabled
    
    Returns:
    
    this
  - withAboutVersionString
```
public LibsBuilder withAboutVersionString(java.lang.String aboutVersionString)
```
    Builder method to enable the display and set the text of the application version in the about this app view
    
    Parameters:
    
    aboutVersionString - enabled or disabled
    
    Returns:
    
    this
  - withAboutAppName
```
public LibsBuilder withAboutAppName(java.lang.String aboutAppName)
```
    Builder method to enable the display and set the text of the application name in the about this app view
    
    Parameters:
    
    aboutAppName - the name of this application
    
    Returns:
    
    this
  - withAboutDescription
```
public LibsBuilder withAboutDescription(java.lang.String aboutDescription)
```
    Builder method to enable the display and set the text of the application description as about this app view
    
    Parameters:
    
    aboutDescription - the description of this application
    
    Returns:
    
    this
  - withAboutSpecial1
```
public LibsBuilder withAboutSpecial1(java.lang.String aboutAppSpecial1)
```
    Parameters:
    
    aboutAppSpecial1 - the special button text
    
    Returns:
    
    this
  - withAboutSpecial1Description
```
public LibsBuilder withAboutSpecial1Description(java.lang.String aboutAppSpecial1Description)
```
    Parameters:
    
    aboutAppSpecial1Description - the special dialog text
    
    Returns:
    
    this
  - withAboutSpecial2
```
public LibsBuilder withAboutSpecial2(java.lang.String aboutAppSpecial2)
```
    Parameters:
    
    aboutAppSpecial2 - the special button text
    
    Returns:
    
    this
  - withAboutSpecial2Description
```
public LibsBuilder withAboutSpecial2Description(java.lang.String aboutAppSpecial2Description)
```
    Parameters:
    
    aboutAppSpecial2Description - the special dialog text
    
    Returns:
    
    this
  - withAboutSpecial3
```
public LibsBuilder withAboutSpecial3(java.lang.String aboutAppSpecial3)
```
    Parameters:
    
    aboutAppSpecial3 - the special button text
    
    Returns:
    
    this
  - withAboutSpecial3Description
```
public LibsBuilder withAboutSpecial3Description(java.lang.String aboutAppSpecial3Description)
```
    Parameters:
    
    aboutAppSpecial3Description - the special dialog text
    
    Returns:
    
    this
  - withActivityTheme
```
public LibsBuilder withActivityTheme(int activityTheme)
```
    Builder method to set the activity theme
    
    Parameters:
    
    activityTheme - as example R.theme.AppTheme (just for the activity)
    
    Returns:
    
    this
  - withActivityTitle
```
public LibsBuilder withActivityTitle(java.lang.String activityTitle)
```
    Builder method to set the ActivityTitle
    
    Parameters:
    
    activityTitle - the activity title (just for the activity)
    
    Returns:
    
    this
  - withActivityColor
```
public LibsBuilder withActivityColor(Colors activityColor)
```
    Builder method to set the ActivityColor
    
    Parameters:
    
    activityColor - the activity color (just for the activity)
    
    Returns:
    
    this
  - withActivityStyle
```
public LibsBuilder withActivityStyle(Libs.ActivityStyle libraryStyle)
```
    Builder method to set the ActivityStyle
    
    Parameters:
    
    libraryStyle - LibraryStyles.LIGHT / DARK / LIGHT_DARK_TOOLBAR
    
    Returns:
    
    this
  - withLibraryModification
```
public LibsBuilder withLibraryModification(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> libraryModification)
```
    Builder method to modify specific libraries. NOTE: This will overwrite any modifications with the helper methods
    
    Parameters:
    
    libraryModification - an HashMap identified by libraryID containing an HashMap with the modifications identified by elementID.
    
    Returns:
    
    this
  - withLibraryModification
```
public LibsBuilder withLibraryModification(java.lang.String library,
                                           Libs.LibraryFields modificationKey,
                                           java.lang.String modificationValue)
```
    Builder helper method to set modifications for specific libraries
    
    Parameters:
    
    library - the library to be modified
    
    modificationKey - the identifier for the specific modification
    
    modificationValue - the value for the specific modification
    
    Returns:
    
    this
  - withListener
```
public LibsBuilder withListener(LibsConfiguration.LibsListener libsListener)
```
    Builder method to set the LibsListener for the AboutLibraries actions
    
    Parameters:
    
    libsListener - the listener to be notified
    
    Returns:
    
    this
  - withLibsRecyclerViewListener
```
public LibsBuilder withLibsRecyclerViewListener(LibsConfiguration.LibsRecyclerViewListener recyclerViewListener)
```
    Builder method to set the LibsRecyclerViewListener for the AboutLibraries recyclerView elements
    
    Parameters:
    
    recyclerViewListener -
    
    Returns:
    
    this
  - withUiListener
```
public LibsBuilder withUiListener(LibsConfiguration.LibsUIListener uiListener)
```
    Builder method to set the LibsUIListener for the AboutLibraries view to hook into the view creation
    
    Parameters:
    
    uiListener -
    
    Returns:
    
    this
  - withLayoutAnimationController
```
public LibsBuilder withLayoutAnimationController(android.view.animation.LayoutAnimationController layoutAnimationController)
```
    Builder method to set the LayoutAnimationController for the RecyclerView
    
    Parameters:
    
    layoutAnimationController -
    
    Returns:
    
    this
  - withLibTaskExecutor
```
public LibsBuilder withLibTaskExecutor(LibTaskExecutor libTaskExecutor)
```
    Builder method to define a custom Thread Executor for asynchronous operations
    
    Parameters:
    
    libTaskExecutor -
    
    Returns:
    
    this
  - withLibTaskCallback
```
public LibsBuilder withLibTaskCallback(LibTaskCallback libTaskCallback)
```
    Builder method to define a custom callback which is invoked every time the LibraryTask gets executed. This interface is called on a LibraryTask's start and end. Make sure the class which implements the LibTaskCallback is Serializable.
    
    Parameters:
    
    libTaskCallback -
    
    Returns:
    
    this
  - withShowLoadingProgress
```
public LibsBuilder withShowLoadingProgress(boolean showLoadingProgress)
```
    Builder method to allow you to disable the automatically shown loading progressBar while the libraries are loading
    
    Parameters:
    
    showLoadingProgress -
    
    Returns:
    
    this
  - adapter
```
public FastAdapter adapter(android.content.Context context)
```
    builder to build an adapter out of the given information ;D
    
    Parameters:
    
    context - the current context
    
    Returns:
    
    a LibsRecyclerViewAdapter with the libraries
  - intent
```
public android.content.Intent intent(android.content.Context ctx)
```
    intent() method to build and create the intent with the set params
    
    Returns:
    
    the intent to start the activity
  - intent
```
public android.content.Intent intent(android.content.Context ctx,
                                     java.lang.Class clazz)
```
    intent() method to build and create the intent with the set params
    
    Returns:
    
    the intent to start the activity
  - start
```
public void start(android.content.Context ctx)
```
    start() method to start the application
  - activity
```
public void activity(android.content.Context ctx)
```
    activity() method to start the application
  - supportFragment
```
public LibsSupportFragment supportFragment()
```
    supportFragment() method to build and create the fragment with the set params
    
    Returns:
    
    the fragment to set in your application
  - fragment
```
public LibsFragment fragment()
```
    supportFragment() method to build and create the fragment with the set params
    
    Returns:
    
    the fragment to set in your application

Class LibsBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fields

internalLibraries

excludeLibraries

autoDetect

checkCachedDetection

sort

libraryComparator

showLicense

showLicenseDialog

showVersion

showLoadingProgress

aboutShowIcon

aboutVersionString

aboutAppName

aboutShowVersion

aboutDescription

aboutShowVersionName

aboutShowVersionCode

aboutAppSpecial1

aboutAppSpecial1Description

aboutAppSpecial2

aboutAppSpecial2Description

aboutAppSpecial3

aboutAppSpecial3Description

activityTheme

activityTitle

activityColor

activityStyle

libTaskExecutor

libraryModification

ownLibsActivityClass

Constructor Detail

LibsBuilder

Method Detail

withOwnLibsActivityClass

withFields

withFields

withLibraries

withExcludedLibraries

withAutoDetect

withCheckCachedDetection

withSortEnabled

withLibraryComparator

withLicenseShown

withLicenseDialog

withVersionShown

withAboutIconShown

withAboutVersionShown

withAboutVersionShownName

withAboutVersionShownCode

withAboutVersionString

withAboutAppName

withAboutDescription

withAboutSpecial1

withAboutSpecial1Description

withAboutSpecial2

withAboutSpecial2Description

withAboutSpecial3

withAboutSpecial3Description

withActivityTheme

withActivityTitle

withActivityColor

withActivityStyle

withLibraryModification

withLibraryModification

withListener

withLibsRecyclerViewListener

withUiListener

withLayoutAnimationController

withLibTaskExecutor

withLibTaskCallback

withShowLoadingProgress

adapter

intent