com.helger.schematron.pure.model

Class PSTitle

java.lang.Object

com.helger.schematron.pure.model.PSTitle

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<PSTitle>, IPSClonableElement<PSTitle>, IPSElement, IPSHasMixedContent, IPSHasTexts, IPSOptionalElement, Serializable

@NotThreadSafe
public class PSTitle
extends Object
implements IPSClonableElement<PSTitle>, IPSOptionalElement, IPSHasMixedContent

A single Schematron title-element.
A summary of the purpose or role of the schema or pattern, for the purpose of documentation or a rich user interface.
An implementation is not required to make use of this element.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PSTitle()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDir(PSDir aDir)
void	addText(String sText) Add a new text element.
List<Object>	getAllContentElements()
List<PSDir>	getAllDirs()
List<String>	getAllTexts()
com.helger.commons.microdom.IMicroElement	getAsMicroElement()
PSTitle	getClone()
boolean	hasAnyText()
boolean	isMinimal()
boolean	isValid(IPSErrorHandler aErrorHandler) Check if this element is specified completely.
String	toString()
void	validateCompletely(IPSErrorHandler aErrorHandler) Check if this element is specified completely.

Methods inherited from class java.lang.Object

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

Constructor Detail

PSTitle

public PSTitle()

Method Detail

isValid

public boolean isValid(@Nonnull
              IPSErrorHandler aErrorHandler)

Description copied from interface: IPSElement

Check if this element is specified completely. This method stops at the first encountered error.

Specified by:

isValid in interface IPSElement

Parameters:

aErrorHandler - The error handler where the error details are stored. May not be null.

Returns:

true if all mandatory fields are set and the element is valid, false otherwise.

validateCompletely

public void validateCompletely(@Nonnull
                      IPSErrorHandler aErrorHandler)

Description copied from interface: IPSElement

Check if this element is specified completely. This method performs all validations independent of the number of encountered error.

Specified by:

validateCompletely in interface IPSElement

Parameters:

aErrorHandler - The error handler where the error details are stored. May not be null.

isMinimal

public boolean isMinimal()

Specified by:

isMinimal in interface IPSElement

Returns:

true if this element conforms to the Schematron minimal syntax, false otherwise.

addText

public void addText(@Nonnull@Nonempty
           String sText)

Description copied from interface: IPSHasTexts

Add a new text element.

Specified by:

addText in interface IPSHasTexts

Parameters:

sText - The text to be added. May not be null.

hasAnyText

public boolean hasAnyText()

Specified by:

hasAnyText in interface IPSHasTexts

Returns:

true if at least one text element is contained, false if not

getAllTexts

@Nonnull
@ReturnsMutableCopy
public List<String> getAllTexts()

Specified by:

getAllTexts in interface IPSHasTexts

Returns:

A copy of all contained text elements. Never null.

addDir

public void addDir(@Nonnull
          PSDir aDir)

getAllDirs

@Nonnull
@ReturnsMutableCopy
public List<PSDir> getAllDirs()

getAllContentElements

@Nonnull
@ReturnsMutableCopy
public List<Object> getAllContentElements()

Specified by:

getAllContentElements in interface IPSHasMixedContent

Returns:

A list of String and PSDir elements.

getAsMicroElement

@Nonnull
public com.helger.commons.microdom.IMicroElement getAsMicroElement()

Specified by:

getAsMicroElement in interface IPSElement

Returns:

The XML representation of this element. Never null.

getClone

@Nonnull
public PSTitle getClone()

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object