com.ibm.portal.resourceaggregator.combiner
Interface ResourceURIVariations

public interface ResourceURIVariations

A ResourceURIVariations object represents a selection of resources.
The resource aggregation framework will choose just one URI out of the set of resources. The purpose of the Resource object is to provide different types of the same resource and let the framework chose which one of the resources fits best within the current rendering context. For instance one could provide multiple resources like this:

1. Default Resource, e.g. res:/contextroot/path/file.min.css
2. Debug Resource, e.g. res:/contextroot/path/file.css
3. RTL Resource, e.g. res:/contextroot/path/fileRTL.min.css
4. RTL Debug Resource, e.g. res:/contextroot/path/fileRTL.css

From above set the system would choose the debug resource when debug mode is turned on, or it would choose the RTL version when accessing with a RTL language such as Arabic.

Since:

8.5.0.3

Method Summary

ResourceURIVariations	add(java.lang.String uri) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, java.util.Locale locale) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, java.util.Locale locale, Resource.URIType... uritypes) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, Resource.URIType... uritypes) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, java.lang.String deviceClass) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, java.lang.String deviceClass, java.util.Locale locale) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, java.lang.String deviceClass, java.util.Locale locale, Resource.URIType... uritypes) Adds a Resource object to the resource variation and initializes it with the given parameters.
ResourceURIVariations	add(java.lang.String uri, java.lang.String deviceClass, Resource.URIType... uritypes) Adds a Resource object to the resource variation and initializes it with the given parameters.

Method Detail

add

ResourceURIVariations add(java.lang.String uri)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          Resource.URIType... uritypes)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

uritypes - the type(s) of the resource

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          java.lang.String deviceClass)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

deviceClass - the device class or device class equation. Must not be null.

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          java.lang.String deviceClass,
                          Resource.URIType... uritypes)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

deviceClass - the device class or device class equation. Must not be null.

uritypes - the type(s) of the resource

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          java.lang.String deviceClass,
                          java.util.Locale locale)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

deviceClass - the device class or device class equation. Must not be null.

locale - the locale this resource is bound to. Must not be null.

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          java.lang.String deviceClass,
                          java.util.Locale locale,
                          Resource.URIType... uritypes)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

deviceClass - the device class or device class equation. Must not be null.

uritypes - the type(s) of the resource

locale - the locale this resource is bound to. Must not be null.

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          java.util.Locale locale,
                          Resource.URIType... uritypes)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

uritypes - the type(s) of the resource

locale - the locale this resource is bound to. Must not be null.

Returns:

returns this object again in order to support chaining calls such as .add().add()

add

ResourceURIVariations add(java.lang.String uri,
                          java.util.Locale locale)

Adds a Resource object to the resource variation and initializes it with the given parameters. Calling this function multiple times allows to add multiple resources into this resource variation.

Parameters:

uri - the uri of the resource. Must not be null.

locale - the locale this resource is bound to. Must not be null.

Returns:

returns this object again in order to support chaining calls such as .add().add()