Package com.composum.sling.clientlibs.handle

Class Clientlib

java.lang.Object

com.composum.sling.clientlibs.handle.Clientlib

All Implemented Interfaces:

ClientlibElement

public class Clientlib
extends Object
implements ClientlibElement

Models a client library, containing one or several ClientlibResourceFolders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Clientlib.Type	Type of the element: Clientlib.Type.link, Clientlib.Type.css, Clientlib.Type.js, Clientlib.Type.img.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CATEGORYNAME_CHARS	Allowed characters in a category name, for use in regex character classes
static String	PROP_CATEGORY	Attribute for Client libraries (only the uppermost folder with RESOURCE_TYPE) that gives a list of categories this client library belongs to.
static String	PROP_ORDER	Attribute for Client libraries (only the uppermost folder with RESOURCE_TYPE) that gives an integer that orders the client libraries if there are several belonging to the same PROP_CATEGORY .
ResourceHandle	resource
static String	RESOURCE_TYPE	Resource type of client libraries.

Constructor Summary

Constructors

Constructor	Description
Clientlib(Clientlib.Type type, org.apache.sling.api.resource.Resource resource)

Method Summary

Modifier and Type	Method	Description
void	accept(ClientlibVisitor visitor, ClientlibVisitor.VisitorMode mode, ClientlibResourceFolder parent)	Dispatcher for the appropriate method of visitor: just calls visitor.visit(this, mode, parent);.
boolean	equals(Object o)
@NotNull List<String>	getCategories()
String	getDescription()
int	getOrder()
ClientlibRef	getRef()	A reference that matches this.
ClientlibResourceFolder	getResourceFolder()
Clientlib.Type	getType()	The resource-type for which it was created.
int	hashCode()
boolean	isValid()
ClientlibLink	makeLink()	A link that matches this.
static String	sanitizeCategory(String category)	Removes invalid chars (according to CATEGORYNAME_CHARS) from a category; returns null if there is nothing left / was empty, anyway.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORYNAME_CHARS

public static final String CATEGORYNAME_CHARS

Allowed characters in a category name, for use in regex character classes

See Also:

Constant Field Values

PROP_CATEGORY

public static final String PROP_CATEGORY

Attribute for Client libraries (only the uppermost folder with RESOURCE_TYPE) that gives a list of categories this client library belongs to.

See Also:

Constant Field Values

PROP_ORDER

public static final String PROP_ORDER

Attribute for Client libraries (only the uppermost folder with RESOURCE_TYPE) that gives an integer that orders the client libraries if there are several belonging to the same PROP_CATEGORY . Default value (that is, if not present) is 0.

See Also:

Constant Field Values

RESOURCE_TYPE

public static final String RESOURCE_TYPE

Resource type of client libraries.

See Also:

Constant Field Values

resource

public final ResourceHandle resource

Constructor Detail

Clientlib

public Clientlib(Clientlib.Type type,
                 org.apache.sling.api.resource.Resource resource)

Method Detail

getRef

public ClientlibRef getRef()

A reference that matches this.

Specified by:

getRef in interface ClientlibElement

makeLink

public ClientlibLink makeLink()

A link that matches this.

Specified by:

makeLink in interface ClientlibElement

getType

public Clientlib.Type getType()

Description copied from interface: ClientlibElement

The resource-type for which it was created.

Specified by:

getType in interface ClientlibElement

isValid

public boolean isValid()

getResourceFolder

public ClientlibResourceFolder getResourceFolder()

getOrder

public int getOrder()

getCategories

@NotNull
public @NotNull List<String> getCategories()

getDescription

@Nullable
public String getDescription()

accept

public void accept(ClientlibVisitor visitor,
                   ClientlibVisitor.VisitorMode mode,
                   ClientlibResourceFolder parent)
            throws IOException,
                   javax.jcr.RepositoryException

Description copied from interface: ClientlibElement

Dispatcher for the appropriate method of visitor: just calls visitor.visit(this, mode, parent);.

Specified by:

accept in interface ClientlibElement

Parameters:

visitor - the visitor we want to dispatch to

mode - processing mode

parent - if applicable, the parent of the visited resource

Throws:

IOException

javax.jcr.RepositoryException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

sanitizeCategory

public static String sanitizeCategory(String category)

Removes invalid chars (according to CATEGORYNAME_CHARS) from a category; returns null if there is nothing left / was empty, anyway.