org.apache.sling.feature

Class Extension

java.lang.Object

org.apache.sling.feature.Extension

public class Extension
extends Object

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

This class is not thread-safe.

See Also:

ExtensionType

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_NAME_ASSEMBLED_FEATURES Extension name containing the assembled features as produced by FeatureBuilder.assemble(ArtifactId, BuilderContext, Feature...).
static String	EXTENSION_NAME_CONTENT_PACKAGES Common extension name to specify the content packages for Apache Sling.
static String	EXTENSION_NAME_REPOINIT Common extension name to specify the repoinit part for Apache Sling.

Constructor Summary

Constructors

Constructor and Description
Extension(ExtensionType t, String name, boolean required) Create a new extension

Method Summary

Modifier and Type	Method and Description
Extension	copy() Create a copy of the Extension
boolean	equals(Object obj)
Artifacts	getArtifacts() Get the artifacts of the extension
String	getJSON() Get the JSON of the extension
String	getName() Get the extension name
String	getText() Get the text of the extension
ExtensionType	getType() Get the extension type
int	hashCode()
boolean	isOptional() Return whether the extension is required or optional
boolean	isRequired() Return whether the extension is required or optional
void	setJSON(String text) Set the JSON of the extension
void	setText(String text) Set the text of the extension
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXTENSION_NAME_REPOINIT

public static final String EXTENSION_NAME_REPOINIT

Common extension name to specify the repoinit part for Apache Sling. This extension is of type ExtensionType.TEXT and is required.

See Also:

Constant Field Values

EXTENSION_NAME_CONTENT_PACKAGES

public static final String EXTENSION_NAME_CONTENT_PACKAGES

Common extension name to specify the content packages for Apache Sling. This extension is of type ExtensionType.ARTIFACTS and is required.

See Also:

Constant Field Values

EXTENSION_NAME_ASSEMBLED_FEATURES

public static final String EXTENSION_NAME_ASSEMBLED_FEATURES

Extension name containing the assembled features as produced by FeatureBuilder.assemble(ArtifactId, BuilderContext, Feature...). This extension is of type ExtensionType.ARTIFACTS and is optional.

See Also:

Constant Field Values

Constructor Detail

Extension

public Extension(ExtensionType t,
                 String name,
                 boolean required)

Create a new extension

Parameters:

t - The type of the extension

name - The name of the extension

required - Whether the extension is required or optional

Throws:

IllegalArgumentException - If name or t are null

Method Detail

getType

public ExtensionType getType()

Get the extension type

Returns:

The type

getName

public String getName()

Get the extension name

Returns:

The name

isRequired

public boolean isRequired()

Return whether the extension is required or optional

Returns:

Return true if the extension is required.

isOptional

public boolean isOptional()

Return whether the extension is required or optional

Returns:

Return true if the extension is optional.

getText

public String getText()

Get the text of the extension

Returns:

The text

Throws:

IllegalStateException - if the type is not ExtensionType#TEXT

setText

public void setText(String text)

Set the text of the extension

Parameters:

text - The text

Throws:

IllegalStateException - if the type is not ExtensionType#TEXT

getJSON

public String getJSON()

Get the JSON of the extension

Returns:

The JSON

Throws:

IllegalStateException - if the type is not ExtensionType#JSON

setJSON

public void setJSON(String text)

Set the JSON of the extension

Parameters:

text - The JSON

Throws:

IllegalStateException - if the type is not ExtensionType#JSON

getArtifacts

public Artifacts getArtifacts()

Get the artifacts of the extension

Returns:

The artifacts

Throws:

IllegalStateException - if the type is not ExtensionType#ARTIFACTS

copy

public Extension copy()

Create a copy of the Extension

Returns:

A copy of the Extension

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object