Package com.adobe.granite.ui.clientlibs
Interface ClientLibrary
-
@ProviderType 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
allowProxy()
Flag indicating if proxying is allowed.String[]
getCategories()
Returns the categories this library is registered for.String[]
getChannels()
Returns the channels associated with this libraryMap<String,? extends ClientLibrary>
getDependencies(boolean transitive)
Resolves the dependencies of this library.String[]
getDependentCategories()
Returns the categories of the dependent librariesMap<String,? extends ClientLibrary>
getEmbedded(LibraryType type)
Returns the embedded libraries filtered by type.String[]
getEmbeddedCategories()
Returns the categories of the embedded librariesString
getIncludePath(LibraryType type)
Returns the include path of this library for the given type.String
getIncludePath(LibraryType type, boolean minified)
Returns the include path of this library for the given type.String
getPath()
Returns the path of this libraryString
getThemeLibId()
Returns the library id in case this is a themed libraryString
getThemeName()
Returns the theme name in case this is a themed library.Set<LibraryType>
getTypes()
Returns the set of types that this library provides.
-
-
-
Method Detail
-
getPath
String getPath()
Returns the path of this library- Returns:
- the path
-
getIncludePath
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
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 typeminified
-true
to return the path to the minified version- Returns:
- the include path
- Since:
- 5.5.30
-
getTypes
Set<LibraryType> getTypes()
Returns the set of types that this library provides.- Returns:
- the types
-
getThemeName
String getThemeName()
Returns the theme name in case this is a themed library.- Returns:
- the theme name or
null
-
getThemeLibId
String getThemeLibId()
Returns the library id in case this is a themed library- Returns:
- the library id or
null
-
getCategories
String[] getCategories()
Returns the categories this library is registered for.- Returns:
- the categories
-
getEmbeddedCategories
String[] getEmbeddedCategories()
Returns the categories of the embedded libraries- Returns:
- the embedded categories
-
getDependentCategories
String[] getDependentCategories()
Returns the categories of the dependent libraries- Returns:
- the embedded categories
-
getChannels
String[] getChannels()
Returns the channels associated with this library- Returns:
- the channels
-
getDependencies
Map<String,? extends ClientLibrary> getDependencies(boolean transitive)
Resolves the dependencies of this library. resolves recursively, if transitive istrue
.- Parameters:
transitive
-true
for recursive resolution- Returns:
- the map of libraries
-
getEmbedded
Map<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
-
-