org.dita.dost.util

Class KeyDef

java.lang.Object

org.dita.dost.util.KeyDef

public class KeyDef
extends java.lang.Object

Key definition.

Field Summary

Fields

Modifier and Type	Field and Description
org.w3c.dom.Element	element
static java.lang.String	ELEMENT_STUB
java.lang.String	format
java.net.URI	href
java.lang.String	keys Space delimited list of key names
java.lang.String	scope
java.net.URI	source

Constructor Summary

Constructors

Constructor and Description
KeyDef(java.lang.String keys, java.net.URI href, java.lang.String scope, java.lang.String format, java.net.URI source, org.w3c.dom.Element element) Construct new key definition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	toString()
static void	writeKeydef(java.io.File keydefFile, java.util.Collection<KeyDef> keydefs) Write key definition XML configuration file

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_STUB

public static final java.lang.String ELEMENT_STUB

See Also:

Constant Field Values

keys

public final java.lang.String keys

Space delimited list of key names

href

public java.net.URI href

scope

public final java.lang.String scope

source

public final java.net.URI source

element

public final org.w3c.dom.Element element

format

public final java.lang.String format

Constructor Detail

KeyDef

public KeyDef(java.lang.String keys,
              java.net.URI href,
              java.lang.String scope,
              java.lang.String format,
              java.net.URI source,
              org.w3c.dom.Element element)

Construct new key definition.

Parameters:

keys - key name

href - href URI, may be null

scope - link scope, may be null

source - key definition source, may be null

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeKeydef

public static void writeKeydef(java.io.File keydefFile,
                               java.util.Collection<KeyDef> keydefs)
                        throws DITAOTException

Write key definition XML configuration file

Parameters:

keydefFile - key definition file

keydefs - list of key definitions

Throws:

DITAOTException - if writing configuration file failed

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object