org.asciidoctor.gradle.model5.core.attributes

Interface Attributes

public interface Attributes

An Asciidoctor-implementation agnostic representation of attributes.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, java.lang.Object value) Add a single attribute
void	addAll(java.util.Map<java.lang.String,java.lang.Object> m) Add additional Asciidoctor attributes.
default void	addAsBoolean(java.lang.String key, java.lang.Object value) Indicates that the value should be treated as a time value.
default void	addAsDate(java.lang.String key, java.lang.Object value) Indicates that the value should be treated as a date value.
default void	addAsTime(java.lang.String key, java.lang.Object value) Indicates that the value should be treated as a time value.
AttributeType	asBoolean(java.lang.Object value) Indicates that the value should be treated as a boolean value.
AttributeType	asDate(java.lang.Object value) Indicates that the value should be treated as a date value.
AttributeType	asTime(java.lang.Object value) Indicates that the value should be treated as a time value.
void	attributeProvider(org.gradle.api.provider.Provider<java.util.Map<java.lang.String,java.lang.Object>> provider) Adds a provider as an additional attribute provider.
org.gradle.api.provider.Provider<java.util.Map<java.lang.String,java.lang.String>>	getAttributeResolver() Resolves all the Asciidoctor options.
void	replaceAll(java.util.Map<java.lang.String,java.lang.Object> m) Apply a new set of Asciidoctor attributes, clearing any attributes and providers previously set.

Method Detail

getAttributeResolver

org.gradle.api.provider.Provider<java.util.Map<java.lang.String,java.lang.String>> getAttributeResolver()

Resolves all the Asciidoctor options.

Resolves values to either boolean, dates or strings. URIs are resolved to string with toAsciiString().

Returns:

A map of resolved attributes

replaceAll

void replaceAll(java.util.Map<java.lang.String,java.lang.Object> m)

Apply a new set of Asciidoctor attributes, clearing any attributes and providers previously set.

Parameters:

m - Map with new options

addAll

void addAll(java.util.Map<java.lang.String,java.lang.Object> m)

Add additional Asciidoctor attributes.

Parameters:

m - Map with new options

add

void add(java.lang.String key,
         java.lang.Object value)

Add a single attribute

Parameters:

key - Name of attribute

value - Value of attribute.

attributeProvider

void attributeProvider(org.gradle.api.provider.Provider<java.util.Map<java.lang.String,java.lang.Object>> provider)

Adds a provider as an additional attribute provider.

Parameters:

provider - A provider that returns a Map<String,Object>.

asTime

AttributeType asTime(java.lang.Object value)

Indicates that the value should be treated as a time value.

Parameters:

value - Value.

Returns:

Something that can be passed as value in members of addAll(Map) or as a single value to add(String, Object)

addAsTime

default void addAsTime(java.lang.String key,
                       java.lang.Object value)

Indicates that the value should be treated as a time value.

Parameters:

key - Attribute name

value - Value.

asDate

AttributeType asDate(java.lang.Object value)

Indicates that the value should be treated as a date value.

Parameters:

value - Value.

Returns:

Something that can be passed as value in members of addAll(Map) or as a single value to add(String, Object)

addAsDate

default void addAsDate(java.lang.String key,
                       java.lang.Object value)

Indicates that the value should be treated as a date value.

Parameters:

key - Attribute name

value - Value.

asBoolean

AttributeType asBoolean(java.lang.Object value)

Indicates that the value should be treated as a boolean value.

Parameters:

value - Value.

Returns:

Something that can be passed as value in members of addAll(Map) or as a single value to add(String, Object)

addAsBoolean

default void addAsBoolean(java.lang.String key,
                          java.lang.Object value)

Indicates that the value should be treated as a time value.

Parameters:

key - Attribute name

value - Value.