Attributes (AsciidoctorJ 1.5.0 API)

java.lang.Object
- org.asciidoctor.Attributes

```
public class Attributes
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_URI_READ`
`static String`	`APPENDIX_CAPTION`
`static String`	`ATTRIBUTE_MISSING`
`static String`	`ATTRIBUTE_UNDEFINED`
`static String`	`BACKEND`
`static String`	`CACHE_URI`
`static String`	`COMPAT_MODE`
`static String`	`COPY_CSS`
`static String`	`DATA_URI`
`static String`	`DOCDATE`
`static String`	`DOCTIME`
`static String`	`DOCTYPE`
`static String`	`EXPERIMENTAL`
`static String`	`FONT_ICONS`
`static String`	`HARDBREAKS`
`static String`	`HIDE_URI_SCHEME`
`static String`	`ICONFONT_CDN`
`static String`	`ICONFONT_NAME`
`static String`	`ICONFONT_REMOTE`
`static String`	`ICONS`
`static String`	`ICONS_DIR`
`static String`	`IGNORE_UNDEFINED`
`static String`	`IMAGE_ICONS`
`static String`	`IMAGESDIR`
`static String`	`LINK_ATTRS`
`static String`	`LINK_CSS`
`static String`	`LOCALDATE`
`static String`	`LOCALTIME`
`static String`	`MATH`
`static String`	`MAX_INCLUDE_DEPTH`
`static String`	`NO_FOOTER`
`static String`	`NOT_STYLESHEET_NAME`
`static String`	`SECT_NUM_LEVELS`
`static String`	`SECTION_NUMBERS`
`static String`	`SET_ANCHORS`
`static String`	`SHOW_TITLE`
`static String`	`SKIP_FRONT_MATTER`
`static String`	`SOURCE_HIGHLIGHTER`
`static String`	`SOURCE_LANGUAGE`
`static String`	`STYLES_DIR`
`static String`	`STYLESHEET_NAME`
`static String`	`TITLE`
`static String`	`TOC`
`static String`	`TOC_2`
`static String`	`TOC_POSITION`
`static String`	`UNTITLED_LABEL`

Constructor Summary

Constructors
Constructor and Description

Attributes()

Attributes(Map<String,Object> attributes)

Attributes(String attributes)

Attributes(String[] attributes)

Constructors
Constructor and Description
`Attributes()`
`Attributes(Map<String,Object> attributes)`
`Attributes(String attributes)`
`Attributes(String[] attributes)`

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`map()`
`void`	`setAllowUriRead(boolean allowUriRead)`
`void`	`setAnchors(boolean setAnchors)` Sets setanchor flag.
`void`	`setAppendixCaption(String appendixCaption)`
`void`	`setAttribute(String attributeName, Object attributeValue)`
`void`	`setAttributeMissing(String attributeMissing)`
`void`	`setAttributes(Map<String,Object> attributes)` Adds all attributes.
`void`	`setAttributes(String... attributes)` Sets attributes in array form.
`void`	`setAttributes(String attributes)` Sets attributes in string form.
`void`	`setAttributeUndefined(String attributeUndefined)`
`void`	`setBackend(String backend)`
`void`	`setCacheUri(boolean hardbreaks)`
`void`	`setCompatMode(CompatMode compatMode)` Sets compat-mode attribute.
`void`	`setCopyCss(boolean copyCss)` Sets copy css attribute.
`void`	`setDataUri(boolean dataUri)` Sets data-uri attribute.
`void`	`setDocDate(Date docDate)` Sets date in format yyyy-MM-dd
`void`	`setDocTime(Date docTime)` Sets time in format HH:mm:ss z
`void`	`setDocType(String docType)`
`void`	`setExperimental(boolean experimental)` Sets experimental attribute.
`void`	`setHardbreaks(boolean hardbreaks)`
`void`	`setHideUriScheme(boolean hideUriScheme)`
`void`	`setIconFontCdn(URI cdnUri)` The URI prefix of the icon font; looks for minified CSS file based on iconfont-name value; used when iconfont-remote is set
`void`	`setIconFontName(String iconFontName)` The name of the stylesheet in the stylesdir to load (.css extension added automatically)
`void`	`setIconFontRemote(boolean iconFontRemote)` Enable icon font remote attribute.
`void`	`setIcons(String iconsName)` Sets which admonition icons to use.
`void`	`setIconsDir(String iconsDir)` Sets icons directory.
`void`	`setIgnoreUndefinedAttributes(boolean ignoreUndefinedAttributes)` Sets ignore undefined flag so lines are kept when they contain a reference to a missing attribute.
`void`	`setImagesDir(String imagesDir)`
`void`	`setLinkAttrs(boolean linkAttrs)` Sets linkattrs attribute.
`void`	`setLinkCss(boolean linkCss)` Sets link css attribute.
`void`	`setLocalDate(Date localDate)` Sets date in format yyyy-MM-dd
`void`	`setLocalTime(Date localTime)` Sets time in format HH:mm:ss z
`void`	`setMath(String math)`
`void`	`setMaxIncludeDepth(int maxIncludeDepth)`
`void`	`setNoFooter(boolean noFooter)` Sets nofooter attribute.
`void`	`setSectionNumbers(boolean sectionNumbers)` auto-number section titles in the HTML backend
`void`	`setSectNumLevels(int sectNumLevels)`
`void`	`setShowTitle(boolean showTitle)` Sets showtitle value as an alias for notitle!
`void`	`setSkipFrontMatter(boolean skipFrontMatter)` Skips front matter.
`void`	`setSourceHighlighter(String sourceHighlighter)`
`void`	`setSourceLanguage(String sourceLanguage)`
`void`	`setStylesDir(String stylesDir)` Sets the styles dir.
`void`	`setStyleSheetName(String styleSheetName)` Sets stylesheet name.
`void`	`setTableOfContents(boolean toc)` Sets if a table of contents should be rendered or not.
`void`	`setTableOfContents(Placement placement)` Sets if a table of contents should be rendered or not.
`void`	`setTableOfContents2(Placement placement)` Sets table of contents 2 attribute.
`void`	`setTitle(String title)`
`void`	`setUntitledLabel(String untitledLabel)` Sets the untitled label value.
`static String`	`toAsciidoctorFlag(boolean flag)`
`void`	`unsetStyleSheet()` Unsets stylesheet name so document will be generated without style.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BACKEND
```
public static final String BACKEND
```
    See Also:
    Constant Field Values
  - TITLE
```
public static final String TITLE
```
    See Also:
    Constant Field Values
  - DOCTYPE
```
public static final String DOCTYPE
```
    See Also:
    Constant Field Values
  - IMAGESDIR
```
public static final String IMAGESDIR
```
    See Also:
    Constant Field Values
  - SOURCE_HIGHLIGHTER
```
public static final String SOURCE_HIGHLIGHTER
```
    See Also:
    Constant Field Values
  - SOURCE_LANGUAGE
```
public static final String SOURCE_LANGUAGE
```
    See Also:
    Constant Field Values
  - LOCALDATE
```
public static final String LOCALDATE
```
    See Also:
    Constant Field Values
  - LOCALTIME
```
public static final String LOCALTIME
```
    See Also:
    Constant Field Values
  - DOCDATE
```
public static final String DOCDATE
```
    See Also:
    Constant Field Values
  - DOCTIME
```
public static final String DOCTIME
```
    See Also:
    Constant Field Values
  - TOC
```
public static final String TOC
```
    See Also:
    Constant Field Values
  - STYLESHEET_NAME
```
public static final String STYLESHEET_NAME
```
    See Also:
    Constant Field Values
  - STYLES_DIR
```
public static final String STYLES_DIR
```
    See Also:
    Constant Field Values
  - NOT_STYLESHEET_NAME
```
public static final String NOT_STYLESHEET_NAME
```
    See Also:
    Constant Field Values
  - LINK_CSS
```
public static final String LINK_CSS
```
    See Also:
    Constant Field Values
  - COPY_CSS
```
public static final String COPY_CSS
```
    See Also:
    Constant Field Values
  - ICONS
```
public static final String ICONS
```
    See Also:
    Constant Field Values
  - ICONFONT_REMOTE
```
public static final String ICONFONT_REMOTE
```
    See Also:
    Constant Field Values
  - ICONFONT_CDN
```
public static final String ICONFONT_CDN
```
    See Also:
    Constant Field Values
  - ICONFONT_NAME
```
public static final String ICONFONT_NAME
```
    See Also:
    Constant Field Values
  - ICONS_DIR
```
public static final String ICONS_DIR
```
    See Also:
    Constant Field Values
  - DATA_URI
```
public static final String DATA_URI
```
    See Also:
    Constant Field Values
  - SECTION_NUMBERS
```
public static final String SECTION_NUMBERS
```
    See Also:
    Constant Field Values
  - IMAGE_ICONS
```
public static final String IMAGE_ICONS
```
    See Also:
    Constant Field Values
  - FONT_ICONS
```
public static final String FONT_ICONS
```
    See Also:
    Constant Field Values
  - LINK_ATTRS
```
public static final String LINK_ATTRS
```
    See Also:
    Constant Field Values
  - EXPERIMENTAL
```
public static final String EXPERIMENTAL
```
    See Also:
    Constant Field Values
  - SHOW_TITLE
```
public static final String SHOW_TITLE
```
    See Also:
    Constant Field Values
  - ALLOW_URI_READ
```
public static final String ALLOW_URI_READ
```
    See Also:
    Constant Field Values
  - TOC_POSITION
```
public static final String TOC_POSITION
```
    See Also:
    Constant Field Values
  - TOC_2
```
public static final String TOC_2
```
    See Also:
    Constant Field Values
  - IGNORE_UNDEFINED
```
public static final String IGNORE_UNDEFINED
```
    See Also:
    Constant Field Values
  - UNTITLED_LABEL
```
public static final String UNTITLED_LABEL
```
    See Also:
    Constant Field Values
  - SET_ANCHORS
```
public static final String SET_ANCHORS
```
    See Also:
    Constant Field Values
  - SKIP_FRONT_MATTER
```
public static final String SKIP_FRONT_MATTER
```
    See Also:
    Constant Field Values
  - MAX_INCLUDE_DEPTH
```
public static final String MAX_INCLUDE_DEPTH
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_MISSING
```
public static final String ATTRIBUTE_MISSING
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_UNDEFINED
```
public static final String ATTRIBUTE_UNDEFINED
```
    See Also:
    Constant Field Values
  - NO_FOOTER
```
public static final String NO_FOOTER
```
    See Also:
    Constant Field Values
  - HARDBREAKS
```
public static final String HARDBREAKS
```
    See Also:
    Constant Field Values
  - SECT_NUM_LEVELS
```
public static final String SECT_NUM_LEVELS
```
    See Also:
    Constant Field Values
  - CACHE_URI
```
public static final String CACHE_URI
```
    See Also:
    Constant Field Values
  - MATH
```
public static final String MATH
```
    See Also:
    Constant Field Values
  - APPENDIX_CAPTION
```
public static final String APPENDIX_CAPTION
```
    See Also:
    Constant Field Values
  - HIDE_URI_SCHEME
```
public static final String HIDE_URI_SCHEME
```
    See Also:
    Constant Field Values
  - COMPAT_MODE
```
public static final String COMPAT_MODE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Attributes
```
public Attributes()
```
  - Attributes
```
public Attributes(Map<String,Object> attributes)
```
  - Attributes
```
public Attributes(String[] attributes)
```
  - Attributes
```
public Attributes(String attributes)
```
- Method Detail
  - setAllowUriRead
```
public void setAllowUriRead(boolean allowUriRead)
```
  - setAttributeMissing
```
public void setAttributeMissing(String attributeMissing)
```
  - setAttributeUndefined
```
public void setAttributeUndefined(String attributeUndefined)
```
  - setBackend
```
public void setBackend(String backend)
```
  - setTitle
```
public void setTitle(String title)
```
  - setDocType
```
public void setDocType(String docType)
```
  - setImagesDir
```
public void setImagesDir(String imagesDir)
```
  - setSourceLanguage
```
public void setSourceLanguage(String sourceLanguage)
```
  - setSourceHighlighter
```
public void setSourceHighlighter(String sourceHighlighter)
```
  - setMaxIncludeDepth
```
public void setMaxIncludeDepth(int maxIncludeDepth)
```
  - setSectNumLevels
```
public void setSectNumLevels(int sectNumLevels)
```
  - setHardbreaks
```
public void setHardbreaks(boolean hardbreaks)
```
  - setCacheUri
```
public void setCacheUri(boolean hardbreaks)
```
  - setHideUriScheme
```
public void setHideUriScheme(boolean hideUriScheme)
```
  - setAppendixCaption
```
public void setAppendixCaption(String appendixCaption)
```
  - setMath
```
public void setMath(String math)
```
  - setSkipFrontMatter
```
public void setSkipFrontMatter(boolean skipFrontMatter)
```
    Skips front matter.
    
    Parameters:
    skipFrontMatter - value.
  - setAnchors
```
public void setAnchors(boolean setAnchors)
```
    Sets setanchor flag.
    
    Parameters:
    setAnchors - value.
  - setUntitledLabel
```
public void setUntitledLabel(String untitledLabel)
```
    Sets the untitled label value.
    
    Parameters:
    untitledLabel - value.
  - setIgnoreUndefinedAttributes
```
public void setIgnoreUndefinedAttributes(boolean ignoreUndefinedAttributes)
```
    Sets ignore undefined flag so lines are kept when they contain a reference to a missing attribute.
    
    Parameters:
    ignoreUndefinedAttributes - value.
  - setTableOfContents2
```
public void setTableOfContents2(Placement placement)
```
    Sets table of contents 2 attribute.
    
    Parameters:
    placement - where toc is rendered.
  - setTableOfContents
```
public void setTableOfContents(Placement placement)
```
    Sets if a table of contents should be rendered or not.
    
    Parameters:
    toc - value.
  - setShowTitle
```
public void setShowTitle(boolean showTitle)
```
    Sets showtitle value as an alias for notitle!
    
    Parameters:
    showTitle - value.
  - setTableOfContents
```
public void setTableOfContents(boolean toc)
```
    Sets if a table of contents should be rendered or not.
    
    Parameters:
    toc - value.
  - setLocalDate
```
public void setLocalDate(Date localDate)
```
    Sets date in format yyyy-MM-dd
    
    Parameters:
    localDate - object.
  - setLocalTime
```
public void setLocalTime(Date localTime)
```
    Sets time in format HH:mm:ss z
    
    Parameters:
    localTime - object.
  - setDocDate
```
public void setDocDate(Date docDate)
```
    Sets date in format yyyy-MM-dd
    
    Parameters:
    docDate - object.
  - setDocTime
```
public void setDocTime(Date docTime)
```
    Sets time in format HH:mm:ss z
    
    Parameters:
    docTime - object.
  - setStyleSheetName
```
public void setStyleSheetName(String styleSheetName)
```
    Sets stylesheet name.
    
    Parameters:
    styleSheetName - of css file.
  - unsetStyleSheet
```
public void unsetStyleSheet()
```
    Unsets stylesheet name so document will be generated without style.
  - setStylesDir
```
public void setStylesDir(String stylesDir)
```
    Sets the styles dir.
    
    Parameters:
    stylesDir - directory.
  - setLinkCss
```
public void setLinkCss(boolean linkCss)
```
    Sets link css attribute.
    
    Parameters:
    linkCss - true if css is linked, false if css is embedded.
  - setCopyCss
```
public void setCopyCss(boolean copyCss)
```
    Sets copy css attribute.
    
    Parameters:
    copyCss - true if css should be copied to the output location, false otherwise.
  - setIcons
```
public void setIcons(String iconsName)
```
    Sets which admonition icons to use. Attributes.IMAGE_ICONS constant can be used to use the original icons with images or Attributes.FONT_ICONS for font icons (font-awesome).
    
    Parameters:
    iconsName - value.
  - setIconFontRemote
```
public void setIconFontRemote(boolean iconFontRemote)
```
    Enable icon font remote attribute. If enabled, will use the iconfont-cdn value to load the icon font URI; if disabled, will use the iconfont-name value to locate the icon font CSS file
    
    Parameters:
    iconFontRemote - true if attribute enabled false otherwise.
  - setIconFontCdn
```
public void setIconFontCdn(URI cdnUri)
```
    The URI prefix of the icon font; looks for minified CSS file based on iconfont-name value; used when iconfont-remote is set
    
    Parameters:
    cdnUri - uri where css is stored.
  - setIconFontName
```
public void setIconFontName(String iconFontName)
```
    The name of the stylesheet in the stylesdir to load (.css extension added automatically)
    
    Parameters:
    iconFontName - stylesheet name without .css extension.
  - setDataUri
```
public void setDataUri(boolean dataUri)
```
    Sets data-uri attribute.
    
    Parameters:
    dataUri - true if images should be embedded, false otherwise.
  - setIconsDir
```
public void setIconsDir(String iconsDir)
```
    Sets icons directory.
    
    Parameters:
    iconsDir -
  - setSectionNumbers
```
public void setSectionNumbers(boolean sectionNumbers)
```
    auto-number section titles in the HTML backend
    
    Parameters:
    sectionNumbers -
  - setLinkAttrs
```
public void setLinkAttrs(boolean linkAttrs)
```
    Sets linkattrs attribute.
    
    Parameters:
    linkAttrs - true if Asciidoctor should parse link macro attributes, false otherwise.
  - setExperimental
```
public void setExperimental(boolean experimental)
```
    Sets experimental attribute.
    
    Parameters:
    experimental - true if experimental features should be enabled, false otherwise.
  - setNoFooter
```
public void setNoFooter(boolean noFooter)
```
    Sets nofooter attribute.
    
    Parameters:
    noFooter - true if the footer block should not be shown, false otherwise.
  - setCompatMode
```
public void setCompatMode(CompatMode compatMode)
```
    Sets compat-mode attribute.
    
    Parameters:
    compatMode - value.
  - setAttribute
```
public void setAttribute(String attributeName,
                Object attributeValue)
```
  - setAttributes
```
public void setAttributes(String attributes)
```
    Sets attributes in string form. An example of a valid string would be: 'toc numbered source-highlighter=coderay' where you are adding three attributes: toc, numbered and source-highlighter with value coderay.
    
    Parameters:
    attributes - in string format.
  - setAttributes
```
public void setAttributes(String... attributes)
```
    Sets attributes in array form. An example of a valid array would be: '['toc', 'numbered']' where you are adding three attributes: toc and numbered.
    
    Parameters:
    attributes - in array format.
  - setAttributes
```
public void setAttributes(Map<String,Object> attributes)
```
    Adds all attributes.
    
    Parameters:
    attributes - to add.
  - map
```
public Map<String,Object> map()
```
  - toAsciidoctorFlag
```
public static String toAsciidoctorFlag(boolean flag)
```

Class Attributes

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BACKEND

TITLE

DOCTYPE

IMAGESDIR

SOURCE_HIGHLIGHTER

SOURCE_LANGUAGE

LOCALDATE

LOCALTIME

DOCDATE

DOCTIME

TOC

STYLESHEET_NAME

STYLES_DIR

NOT_STYLESHEET_NAME

LINK_CSS

COPY_CSS

ICONS

ICONFONT_REMOTE

ICONFONT_CDN

ICONFONT_NAME

ICONS_DIR

DATA_URI

SECTION_NUMBERS

IMAGE_ICONS

FONT_ICONS

LINK_ATTRS

EXPERIMENTAL

SHOW_TITLE

ALLOW_URI_READ

TOC_POSITION

TOC_2

IGNORE_UNDEFINED

UNTITLED_LABEL

SET_ANCHORS

SKIP_FRONT_MATTER

MAX_INCLUDE_DEPTH

ATTRIBUTE_MISSING

ATTRIBUTE_UNDEFINED

NO_FOOTER

HARDBREAKS

SECT_NUM_LEVELS

CACHE_URI

MATH

APPENDIX_CAPTION

HIDE_URI_SCHEME

COMPAT_MODE

Constructor Detail

Attributes

Attributes

Attributes

Attributes

Method Detail

setAllowUriRead

setAttributeMissing

setAttributeUndefined

setBackend

setTitle

setDocType

setImagesDir

setSourceLanguage

setSourceHighlighter

setMaxIncludeDepth

setSectNumLevels

setHardbreaks

setCacheUri

setHideUriScheme

setAppendixCaption

setMath

setSkipFrontMatter

setAnchors

setUntitledLabel

setIgnoreUndefinedAttributes

setTableOfContents2

setTableOfContents