Module com.aoapps.taglib

Package com.aoapps.taglib

Class MutableGlobalAttributes

java.lang.Object

com.aoapps.taglib.MutableGlobalAttributes

All Implemented Interfaces:

Freezable<GlobalAttributes>, GlobalAttributes

public class MutableGlobalAttributes
extends Object
implements GlobalAttributes, Freezable<GlobalAttributes>

Builder for GlobalAttributes instances.

Constructor Summary

Constructors

Constructor	Description
MutableGlobalAttributes()
MutableGlobalAttributes(GlobalAttributes global)

Method Summary

Modifier and Type	Method	Description
MutableGlobalAttributes	addData(String attrName, Object value)	Adds the data with the provided HTML attribute name and value, replacing any attribute that already exists.
MutableGlobalAttributes	addData(Map<String,?> data)	Adds all the data with the provided HTML attribute names and values, replacing any attributes that already exist.
GlobalAttributes	freeze()	Gets an immutable, thread-safe instance.
Object	getClazz()	Getter required.
Map<String,Object>	getData()	Gets the HTML data attributes or an empty map when there are none.
String	getDir()
String	getId()
Object	getStyle()
MutableGlobalAttributes	removeData(Iterable<String> attrNames)	Removes the data with the provided HTML attribute names.
MutableGlobalAttributes	removeData(String attrName)	Removes the data with the provided HTML attribute name.
MutableGlobalAttributes	setClazz(Object clazz)
MutableGlobalAttributes	setData(Map<String,?> data)	Replaces all the data with the provided HTML attribute names and values.
MutableGlobalAttributes	setDir(String dir)
MutableGlobalAttributes	setId(String id)
MutableGlobalAttributes	setStyle(Object style)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MutableGlobalAttributes

public MutableGlobalAttributes()

MutableGlobalAttributes

public MutableGlobalAttributes(GlobalAttributes global)

Method Details

getId

public String getId()

Specified by:

getId in interface GlobalAttributes

setId

public MutableGlobalAttributes setId(String id)

getClazz

public Object getClazz()

Description copied from interface: GlobalAttributes

Getter required. Because without it, we get the exception:

Unable to find setter method for attribute: class

Specified by:

getClazz in interface GlobalAttributes

setClazz

public MutableGlobalAttributes setClazz(Object clazz)

getData

public Map<String,Object> getData()

Description copied from interface: GlobalAttributes

Gets the HTML data attributes or an empty map when there are none.

Specified by:

getData in interface GlobalAttributes

setData

public MutableGlobalAttributes setData(Map<String,?> data)
                                throws IllegalArgumentException

Replaces all the data with the provided HTML attribute names and values. Entries will a null value are not added.

Throws:

IllegalArgumentException - When attrName is not valid

See Also:

• GlobalBufferedAttributes.setData(java.util.Map)

addData

public MutableGlobalAttributes addData(Map<String,?> data)
                                throws IllegalArgumentException

Adds all the data with the provided HTML attribute names and values, replacing any attributes that already exist. Entries with a null value will remove any existing attribute.

Throws:

IllegalArgumentException - When attrName is not valid

addData

public MutableGlobalAttributes addData(String attrName,
 Object value)
                                throws IllegalArgumentException

Adds the data with the provided HTML attribute name and value, replacing any attribute that already exists. When value is null, will remove an existing attribute.

Throws:

IllegalArgumentException - When attrName is not valid

See Also:

• DataAttribute.addData(java.lang.String, java.lang.Object)

removeData

public MutableGlobalAttributes removeData(Iterable<String> attrNames)

Removes the data with the provided HTML attribute names.

removeData

public MutableGlobalAttributes removeData(String attrName)

Removes the data with the provided HTML attribute name.

getDir

public String getDir()

Specified by:

getDir in interface GlobalAttributes

setDir

public MutableGlobalAttributes setDir(String dir)
                               throws IllegalArgumentException

Throws:

IllegalArgumentException

getStyle

public Object getStyle()

Specified by:

getStyle in interface GlobalAttributes

setStyle

public MutableGlobalAttributes setStyle(Object style)

freeze

public GlobalAttributes freeze()

Gets an immutable, thread-safe instance.

Specified by:

freeze in interface Freezable<GlobalAttributes>

Returns:

The instance or ImmutableGlobalAttributes.EMPTY when empty.

See Also:

• ImmutableGlobalAttributes.of(com.aoapps.taglib.GlobalAttributes)