Package com.helger.html.js

Class CollectingJSCodeProvider

java.lang.Object

com.helger.html.js.CollectingJSCodeProvider

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<CollectingJSCodeProvider>, com.helger.commons.lang.IHasSize, IHasJSCode, IHasJSCodeWithSettings, Serializable

@NotThreadSafe
public class CollectingJSCodeProvider
extends Object
implements IHasJSCodeWithSettings, com.helger.commons.lang.IHasSize, com.helger.commons.lang.ICloneable<CollectingJSCodeProvider>

A JSCode provider that encapsulates a list of IHasJSCode elements and itself implements IHasJSCode.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CollectingJSCodeProvider()
CollectingJSCodeProvider(IHasJSCode... aProviders)
CollectingJSCodeProvider(Iterable<? extends IHasJSCode> aProviders)

Method Summary

Modifier and Type	Method	Description
CollectingJSCodeProvider	addAt(int nIndex, IHasJSCode aProvider)	Add JS code at the specified index.
CollectingJSCodeProvider	addFlattenedAt(int nIndex, IHasJSCode aProvider)	Add JS code at the specified index but unwrapping any CollectingJSCodeProvider instances.
CollectingJSCodeProvider	append(IHasJSCode aProvider)
CollectingJSCodeProvider	appendFlattened(IHasJSCode aProvider)
com.helger.commons.collection.impl.ICommonsList<IHasJSCode>	directAll()
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<IHasJSCode>	getAll()
CollectingJSCodeProvider	getClone()
String	getJSCode(IJSWriterSettings aSettings)
int	hashCode()
boolean	isEmpty()
CollectingJSCodeProvider	prepend(IHasJSCode aProvider)
CollectingJSCodeProvider	prependFlattened(IHasJSCode aProvider)
CollectingJSCodeProvider	removeAt(int nIndex)	Remove the entry at the specified index.
void	reset()
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.html.js.IHasJSCodeWithSettings

getJSCode

Methods inherited from interface com.helger.commons.lang.IHasSize

isNotEmpty

Constructor Detail

CollectingJSCodeProvider

public CollectingJSCodeProvider()

CollectingJSCodeProvider

public CollectingJSCodeProvider(@Nullable
                                IHasJSCode... aProviders)

CollectingJSCodeProvider

public CollectingJSCodeProvider(@Nullable
                                Iterable<? extends IHasJSCode> aProviders)

Method Detail

directAll

@Nonnull
@ReturnsMutableObject
public com.helger.commons.collection.impl.ICommonsList<IHasJSCode> directAll()

Returns:

The underlying modifiable list. Never null but maybe empty.

getAll

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IHasJSCode> getAll()

Returns:

A copy of the list with all members. Never null but maybe empty.

addAt

@Nonnull
public CollectingJSCodeProvider addAt(@Nonnegative
                                      int nIndex,
                                      @Nullable
                                      IHasJSCode aProvider)

Add JS code at the specified index.

Parameters:

nIndex - The index where the element should be added. Should be ≥ 0.

aProvider - The JS code provider to be added. May be null.

Returns:

this for chaining

addFlattenedAt

@Nonnull
public CollectingJSCodeProvider addFlattenedAt(@Nonnegative
                                               int nIndex,
                                               @Nullable
                                               IHasJSCode aProvider)

Add JS code at the specified index but unwrapping any CollectingJSCodeProvider instances.

Parameters:

nIndex - The index where the element should be added. Should be ≥ 0.

aProvider - The JS code provider to be added. May be null.

Returns:

this for chaining

append

@Nonnull
public CollectingJSCodeProvider append(@Nullable
                                       IHasJSCode aProvider)

appendFlattened

@Nonnull
public CollectingJSCodeProvider appendFlattened(@Nullable
                                                IHasJSCode aProvider)

prepend

@Nonnull
public CollectingJSCodeProvider prepend(@Nullable
                                        IHasJSCode aProvider)

prependFlattened

@Nonnull
public CollectingJSCodeProvider prependFlattened(@Nullable
                                                 IHasJSCode aProvider)

removeAt

@Nonnull
public CollectingJSCodeProvider removeAt(@Nonnegative
                                         int nIndex)

Remove the entry at the specified index.

Parameters:

nIndex - the index to be removed. Should be ≥ 0.

Returns:

this for chaining

reset

public void reset()

size

@Nonnegative
public int size()

Specified by:

size in interface com.helger.commons.lang.IHasSize

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.helger.commons.lang.IHasSize

getJSCode

@Nonnull
public String getJSCode(@Nullable
                        IJSWriterSettings aSettings)

Specified by:

getJSCode in interface IHasJSCodeWithSettings

Parameters:

aSettings - The formatter settings to be used. May be null for the default settings.

Returns:

The JavaScript code representation. May be null to indicate no JS code.

getClone

@Nonnull
public CollectingJSCodeProvider getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<CollectingJSCodeProvider>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object