com.day.cq.widget

Interface ClientLibrary

public interface ClientLibrary

ClientLibrary represents a client library as defined in content. a client library can have categories, dependencies and produce different types of html libraries.

Since:

5.4

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowProxy() Flag indicating if proxying is allowed.
java.lang.String[]	getCategories() Returns the categories this library is registered for.
java.lang.String[]	getChannels() Returns the channels associated with this library
java.util.Map<java.lang.String,? extends ClientLibrary>	getDependencies(boolean transitive) Resolves the dependencies of this library.
java.lang.String[]	getDependentCategories() Returns the categories of the dependent libraries
java.util.Map<java.lang.String,? extends ClientLibrary>	getEmbedded(LibraryType type) Returns the embedded libraries filtered by type.
java.lang.String[]	getEmbeddedCategories() Returns the categories of the embedded libraries
java.lang.String	getIncludePath(LibraryType type) Returns the include path of this library for the given type.
java.lang.String	getIncludePath(LibraryType type, boolean minified) Returns the include path of this library for the given type.
java.lang.String	getPath() Returns the path of this library
java.lang.String	getThemeLibId() Returns the library id in case this is a themed library
java.lang.String	getThemeName() Returns the theme name in case this is a themed library.
java.util.Set<LibraryType>	getTypes() Returns the set of types that this library provides.

Method Detail

getPath

java.lang.String getPath()

Returns the path of this library

Returns:

the path

getIncludePath

java.lang.String getIncludePath(LibraryType type)

Returns the include path of this library for the given type. If the library does not support the given type, null is returned.

Parameters:

type - library type

Returns:

the include path

getIncludePath

java.lang.String getIncludePath(LibraryType type,
                              boolean minified)

Returns the include path of this library for the given type. If the library does not support the given type, null is returned.

Parameters:

type - library type

minified - true to return the path to the minified version

Returns:

the include path

Since:

5.5.30

getTypes

java.util.Set<LibraryType> getTypes()

Returns the set of types that this library provides.

Returns:

the types

getThemeName

java.lang.String getThemeName()

Returns the theme name in case this is a themed library.

Returns:

the theme name or null

getThemeLibId

java.lang.String getThemeLibId()

Returns the library id in case this is a themed library

Returns:

the library id or null

getCategories

java.lang.String[] getCategories()

Returns the categories this library is registered for.

Returns:

the categories

getEmbeddedCategories

java.lang.String[] getEmbeddedCategories()

Returns the categories of the embedded libraries

Returns:

the embedded categories

getDependentCategories

java.lang.String[] getDependentCategories()

Returns the categories of the dependent libraries

Returns:

the embedded categories

getChannels

java.lang.String[] getChannels()

Returns the channels associated with this library

Returns:

the channels

getDependencies

java.util.Map<java.lang.String,? extends ClientLibrary> getDependencies(boolean transitive)

Resolves the dependencies of this library. resolves recursively, if transitive is true.

Parameters:

transitive - true for recursive resolution

Returns:

the map of libraries

getEmbedded

java.util.Map<java.lang.String,? extends ClientLibrary> getEmbedded(LibraryType type)

Returns the embedded libraries filtered by type. Note that if this is a themed library, only themed dependencies are returned and vice-versa.

Parameters:

type - type filter

Returns:

the map of libraries

allowProxy

boolean allowProxy()

Flag indicating if proxying is allowed.

Returns:

true if proxy is allowed.

Since:

5.5.38