Skip navigation links
A B C D E F G H I K M O P R S T V 

A

add(FeatureExtensionHandler) - Method in class org.apache.sling.feature.builder.BuilderContext
Add a feature extension handler
add(Artifact) - Method in class org.apache.sling.feature.Bundles
Add an artifact as a bundle.
Application - Class in org.apache.sling.feature
An application consists of Framework Bundles Configurations Framework properties Extensions Feature ids (of the features making up this application)
Application() - Constructor for class org.apache.sling.feature.Application
 
ApplicationBuilder - Class in org.apache.sling.feature.builder
Build an application based on features.
ApplicationBuilder() - Constructor for class org.apache.sling.feature.builder.ApplicationBuilder
 
Artifact - Class in org.apache.sling.feature
An artifact consists of An id metadata
Artifact(ArtifactId) - Constructor for class org.apache.sling.feature.Artifact
Construct a new artifact
ArtifactId - Class in org.apache.sling.feature
An artifact identifier.
ArtifactId(String, String, String, String, String) - Constructor for class org.apache.sling.feature.ArtifactId
Create a new artifact object
assemble(Application, BuilderContext, Feature...) - Static method in class org.apache.sling.feature.builder.ApplicationBuilder
Assemble an application based on the provided features.
assemble(Feature, BuilderContext) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
Assemble the full feature by processing all includes.

B

BuilderContext - Class in org.apache.sling.feature.builder
Builder context holds services used by ApplicationBuilder and FeatureBuilder.
BuilderContext(FeatureProvider) - Constructor for class org.apache.sling.feature.builder.BuilderContext
Create a new context
Bundles - Class in org.apache.sling.feature
Bundles groups a list of bundles Artifact and provides a means to sort them based on start order.
Bundles() - Constructor for class org.apache.sling.feature.Bundles
 

C

canMerge(String) - Method in interface org.apache.sling.feature.builder.FeatureExtensionHandler
Checks whether this merger can merge extensions with that name
clear() - Method in class org.apache.sling.feature.Bundles
Clear the bundles list.
clear() - Method in class org.apache.sling.feature.KeyValueMap
Clear the map
compareTo(Artifact) - Method in class org.apache.sling.feature.Artifact
 
compareTo(ArtifactId) - Method in class org.apache.sling.feature.ArtifactId
 
compareTo(Configuration) - Method in class org.apache.sling.feature.Configuration
 
compareTo(Feature) - Method in class org.apache.sling.feature.Feature
 
compareTo(Include) - Method in class org.apache.sling.feature.Include
 
Configuration - Class in org.apache.sling.feature
A configuration has either a pid or a factory pid and a name and properties.
Configuration(String) - Constructor for class org.apache.sling.feature.Configuration
Create a new configuration
Configuration(String, String) - Constructor for class org.apache.sling.feature.Configuration
Create a new factor configuration
Configurations - Class in org.apache.sling.feature
A container for configurations.
Configurations() - Constructor for class org.apache.sling.feature.Configurations
 
containsExact(ArtifactId) - Method in class org.apache.sling.feature.Bundles
Checks whether the exact artifact is available
containsSame(ArtifactId) - Method in class org.apache.sling.feature.Bundles
Checks whether the same artifact is available, neglecting the version
copy() - Method in class org.apache.sling.feature.Feature
Create a copy of the feature
copy(ArtifactId) - Method in class org.apache.sling.feature.Feature
Create a copy of the feature with a different id

D

deduplicate(BuilderContext, Feature...) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
Remove duplicate and included features.

E

equals(Object) - Method in class org.apache.sling.feature.Artifact
 
equals(Object) - Method in class org.apache.sling.feature.ArtifactId
 
equals(Object) - Method in class org.apache.sling.feature.Extension
 
equals(Object) - Method in class org.apache.sling.feature.Feature
 
equals(Object) - Method in class org.apache.sling.feature.Include
 
equals(Object) - Method in class org.apache.sling.feature.KeyValueMap
 
Extension - Class in org.apache.sling.feature
An Extension can either be of type Artifacts : it contains a list of artifacts Text : it contains text JSON : it contains a blob of JSON
Extension(ExtensionType, String, boolean) - Constructor for class org.apache.sling.feature.Extension
Create a new extension
EXTENSION_NAME_CONTENT_PACKAGES - Static variable in class org.apache.sling.feature.FeatureConstants
Common extension name to specify the content packages for Apache Sling.
EXTENSION_NAME_REPOINIT - Static variable in class org.apache.sling.feature.FeatureConstants
Common extension name to specify the repoinit part for Apache Sling.
Extensions - Class in org.apache.sling.feature
A container for extensions
Extensions() - Constructor for class org.apache.sling.feature.Extensions
 
ExtensionType - Enum in org.apache.sling.feature
Enumeration for Extension types.

F

Feature - Class in org.apache.sling.feature
A feature consists of A unique id ArtifactId Bundles Configurations Framework properties Requirements and capabilities Includes Extensions
Feature(ArtifactId) - Constructor for class org.apache.sling.feature.Feature
Construct a new feature.
FeatureBuilder - Class in org.apache.sling.feature.builder
 
FeatureBuilder() - Constructor for class org.apache.sling.feature.builder.FeatureBuilder
 
FeatureConstants - Class in org.apache.sling.feature
 
FeatureConstants() - Constructor for class org.apache.sling.feature.FeatureConstants
 
FeatureExtensionHandler - Interface in org.apache.sling.feature.builder
A feature extension handler can merge a feature of a particular type and also post process the final assembled feature.
FeatureProvider - Interface in org.apache.sling.feature.builder
The feature provider is used to find features while assembling using either ApplicationBuilder or FeatureBuilder.
fromMvnId(String) - Static method in class org.apache.sling.feature.ArtifactId
Create a new artifact id from maven coordinates/id groupId:artifactId[:packaging[:classifier]]:version
fromMvnUrl(String) - Static method in class org.apache.sling.feature.ArtifactId
Create a new artifact id from a maven url, 'mvn:' group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]

G

get(String) - Method in class org.apache.sling.feature.KeyValueMap
Get an item from the map.
getArtifactExtensionRemovals() - Method in class org.apache.sling.feature.Include
 
getArtifactId() - Method in class org.apache.sling.feature.ArtifactId
Return the artifact id.
getArtifacts() - Method in class org.apache.sling.feature.Extension
Get the artifacts of the extension
getBundleRemovals() - Method in class org.apache.sling.feature.Include
 
getBundles() - Method in class org.apache.sling.feature.Application
Get the bundles
getBundles() - Method in class org.apache.sling.feature.Feature
Get the bundles.
getBundlesByStartOrder() - Method in class org.apache.sling.feature.Bundles
Get the map of all bundles sorted by start order.
getByName(String) - Method in class org.apache.sling.feature.Extensions
Get an extension by name
getCapabilities() - Method in class org.apache.sling.feature.Feature
Get the list of capabilities.
getClassifier() - Method in class org.apache.sling.feature.ArtifactId
Return the optional classifier.
getConfiguration(String) - Method in class org.apache.sling.feature.Configurations
Get the configuration
getConfigurationRemovals() - Method in class org.apache.sling.feature.Include
 
getConfigurations() - Method in class org.apache.sling.feature.Application
Get the configurations The list is modifiable.
getConfigurations() - Method in class org.apache.sling.feature.Feature
Get the configurations.
getDescription() - Method in class org.apache.sling.feature.Feature
Get the description
getExtensionRemovals() - Method in class org.apache.sling.feature.Include
 
getExtensions() - Method in class org.apache.sling.feature.Application
Get the list of extensions The list is modifiable
getExtensions() - Method in class org.apache.sling.feature.Feature
Get the list of extensions.
getFactoryConfiguration(String, String) - Method in class org.apache.sling.feature.Configurations
Get the factory configuration
getFactoryPid() - Method in class org.apache.sling.feature.Configuration
Return the factory pid
getFeatureIds() - Method in class org.apache.sling.feature.Application
Get the list of used features to build this application
getFramework() - Method in class org.apache.sling.feature.Application
Get the framework id
getFrameworkProperties() - Method in class org.apache.sling.feature.Application
Get the framework properties The map is modifiable
getFrameworkProperties() - Method in class org.apache.sling.feature.Feature
Get the framework properties The returned object is modifiable.
getFrameworkPropertiesRemovals() - Method in class org.apache.sling.feature.Include
 
getGroupId() - Method in class org.apache.sling.feature.ArtifactId
Return the group id.
getId() - Method in class org.apache.sling.feature.Artifact
Get the id of the artifact.
getId() - Method in class org.apache.sling.feature.Feature
Get the id of the artifact.
getId() - Method in class org.apache.sling.feature.Include
Get the id of the artifact.
getIncludes() - Method in class org.apache.sling.feature.Feature
Get the list of includes.
getJSON() - Method in class org.apache.sling.feature.Extension
Get the JSON of the extension
getLicense() - Method in class org.apache.sling.feature.Feature
Get the license
getLocation() - Method in class org.apache.sling.feature.Feature
Get the location.
getMetadata() - Method in class org.apache.sling.feature.Artifact
Get the metadata of the artifact.
getName() - Method in class org.apache.sling.feature.Configuration
Return the name for a factory configuration.
getName() - Method in class org.apache.sling.feature.Extension
Get the extension name
getObject(String) - Method in class org.apache.sling.feature.KeyValueMap
 
getOSGiVersion() - Method in class org.apache.sling.feature.ArtifactId
Return the OSGi version
getPid() - Method in class org.apache.sling.feature.Configuration
Get the pid.
getProperties() - Method in class org.apache.sling.feature.Configuration
Get all properties of the configuration.
getRequirements() - Method in class org.apache.sling.feature.Feature
Get the list of requirements.
getSame(ArtifactId) - Method in class org.apache.sling.feature.Bundles
Get the artifact for the given id, neglecting the version
getStartOrder() - Method in class org.apache.sling.feature.Artifact
Get the start order of the artifact.
getText() - Method in class org.apache.sling.feature.Extension
Get the text of the extension
getTitle() - Method in class org.apache.sling.feature.Feature
Get the title
getType() - Method in class org.apache.sling.feature.ArtifactId
Return the type.
getType() - Method in class org.apache.sling.feature.Extension
Get the extension type
getVariables() - Method in class org.apache.sling.feature.Application
Get the variables The map is modifiable
getVariables() - Method in class org.apache.sling.feature.Feature
Obtain the variables of the feature
getVendor() - Method in class org.apache.sling.feature.Feature
Get the vendor
getVersion() - Method in class org.apache.sling.feature.ArtifactId
Return the version.

H

hashCode() - Method in class org.apache.sling.feature.Artifact
 
hashCode() - Method in class org.apache.sling.feature.ArtifactId
 
hashCode() - Method in class org.apache.sling.feature.Extension
 
hashCode() - Method in class org.apache.sling.feature.Feature
 
hashCode() - Method in class org.apache.sling.feature.Include
 
hashCode() - Method in class org.apache.sling.feature.KeyValueMap
 

I

Include - Class in org.apache.sling.feature
A include is an inclusion of a feature with optional removals of Configurations / configuration properties Bundles Framework properties Extensions or artifacts from extensions TODO - requirement, capabilities
Include(ArtifactId) - Constructor for class org.apache.sling.feature.Include
Construct a new Include.
isAssembled() - Method in class org.apache.sling.feature.Feature
Check whether the feature is already assembled
isEmpty() - Method in class org.apache.sling.feature.Bundles
Check whether this container has bundles
isEmpty() - Method in class org.apache.sling.feature.KeyValueMap
Check whether this map is empty.
isFactoryConfiguration() - Method in class org.apache.sling.feature.Configuration
Check whether this is a factory configuration
isOptional() - Method in class org.apache.sling.feature.Extension
Return whether the extension is required or optional
isRequired() - Method in class org.apache.sling.feature.Extension
Return whether the extension is required or optional
isSame(ArtifactId) - Method in class org.apache.sling.feature.ArtifactId
Test whether the artifact id is pointing to the same artifact but potentially a different version
iterator() - Method in class org.apache.sling.feature.Bundles
Iterate over all bundles
iterator() - Method in class org.apache.sling.feature.KeyValueMap
 

K

KEY_START_ORDER - Static variable in class org.apache.sling.feature.Artifact
This key might be used by bundles to define the start order.
KeyValueMap - Class in org.apache.sling.feature
Helper class to hold key value pairs.
KeyValueMap() - Constructor for class org.apache.sling.feature.KeyValueMap
 

M

merge(Feature, Feature, String) - Method in interface org.apache.sling.feature.builder.FeatureExtensionHandler
Merge the source extension into the target extension.

O

org.apache.sling.feature - package org.apache.sling.feature
 
org.apache.sling.feature.builder - package org.apache.sling.feature.builder
 

P

parse(String) - Static method in class org.apache.sling.feature.ArtifactId
Create a new artifact id from a string, the string must either be a mvn url or a mvn id (= coordinates)
postProcess(Feature, String) - Method in interface org.apache.sling.feature.builder.FeatureExtensionHandler
Post process the feature with respect to the extension.
PROP_ARTIFACT - Static variable in class org.apache.sling.feature.Configuration
 
provide(ArtifactId) - Method in interface org.apache.sling.feature.builder.FeatureProvider
Provide the feature with the given id.
put(String, Object) - Method in class org.apache.sling.feature.KeyValueMap
Put an item in the map
putAll(KeyValueMap) - Method in class org.apache.sling.feature.KeyValueMap
Put all items from the other map in this map

R

remove(String) - Method in class org.apache.sling.feature.KeyValueMap
Remove an item from the map
removeExact(ArtifactId) - Method in class org.apache.sling.feature.Bundles
Remove the exact artifact.
removeSame(ArtifactId) - Method in class org.apache.sling.feature.Bundles
Remove the same artifact, neglecting the version.
resolve(BuilderContext, String...) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
Resolve a set of features based on their ids.

S

setAssembled(boolean) - Method in class org.apache.sling.feature.Feature
Set the assembled flag
setDescription(String) - Method in class org.apache.sling.feature.Feature
Set the description
setFramework(ArtifactId) - Method in class org.apache.sling.feature.Application
Set the framework id
setJSON(String) - Method in class org.apache.sling.feature.Extension
Set the JSON of the extension
setLicense(String) - Method in class org.apache.sling.feature.Feature
Set the vendor
setLocation(String) - Method in class org.apache.sling.feature.Feature
Set the location.
setStartOrder(int) - Method in class org.apache.sling.feature.Artifact
Set the start order of the artifact This is a convenience method which sets the value of the property named #KEY_START_ORDER from the metadata.
setText(String) - Method in class org.apache.sling.feature.Extension
Set the text of the extension
setTitle(String) - Method in class org.apache.sling.feature.Feature
Set the title
setVendor(String) - Method in class org.apache.sling.feature.Feature
Set the vendor
size() - Method in class org.apache.sling.feature.KeyValueMap
Get the size of the map.

T

toMvnId() - Method in class org.apache.sling.feature.ArtifactId
Return a mvn id
toMvnPath() - Method in class org.apache.sling.feature.ArtifactId
Create a Maven like relative repository path.
toMvnUrl() - Method in class org.apache.sling.feature.ArtifactId
Return a mvn url
toString() - Method in class org.apache.sling.feature.Application
 
toString() - Method in class org.apache.sling.feature.Artifact
 
toString() - Method in class org.apache.sling.feature.ArtifactId
 
toString() - Method in class org.apache.sling.feature.Bundles
 
toString() - Method in class org.apache.sling.feature.Configuration
 
toString() - Method in class org.apache.sling.feature.Extension
 
toString() - Method in class org.apache.sling.feature.Feature
 
toString() - Method in class org.apache.sling.feature.Include
 
toString() - Method in class org.apache.sling.feature.KeyValueMap
 

V

valueOf(String) - Static method in enum org.apache.sling.feature.ExtensionType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.sling.feature.ExtensionType
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I K M O P R S T V 
Skip navigation links

Copyright © 2007–2018 The Apache Software Foundation. All rights reserved.