eu.bandm.tools.dtd

Class DTD.Choice

java.lang.Object

eu.bandm.tools.dtd.DTD.ContentModel

eu.bandm.tools.dtd.DTD.CP

eu.bandm.tools.dtd.DTD.Choice

All Implemented Interfaces:

Formattable, Cloneable

Enclosing class:

DTD

public static class DTD.Choice
extends DTD.CP

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "DTD.umod":73.1-5, cf. this pretty print.)

Field Summary

Fields

Modifier and Type	Field and Description
protected CheckedList<DTD.CP>	alts Generated by umod; model author's documentation MISSING.
protected static int	BASE_HASH

Fields inherited from class eu.bandm.tools.dtd.DTD.CP

modifier, NONE, OPTIONAL, PLUS, STAR

Fields inherited from class eu.bandm.tools.dtd.DTD.ContentModel

ANY, EMPTY

Fields inherited from interface eu.bandm.tools.format.Formattable

format

Constructor Summary

Constructors

Constructor and Description
Choice() Synthetic minimal constructor provided by the umod compiler.
Choice(CheckedList<DTD.CP> alts) Constructor generated according to specification #1 Constructor defined according to directive "C 1/..".
Choice(int modifier, CheckedList<DTD.CP> alts) Constructor generated according to specification #0 Constructor defined according to directive "C 0/..".

Method Summary

Modifier and Type	Method and Description
void	descend_alts(DTD.MATCH_ONLY_00 visitor)
DTD.Choice	doclone() Clones this object.
boolean	equals(Object e0) Generated by umod because this class is ALGEBRAIC.
Format	format() Delivers a format object for pretty-printing, as specified in the umod source.
CheckedList<DTD.CP>	get_alts() Generated by umod; model author's documentation MISSING.
static Pattern<DTD.Choice>	get_alts(Pattern<? super CheckedList<DTD.CP>> p) Lifts a pattern which matches the field value to one which matches this whole object.
static String	getFormatHint() Delivers the format specification from the umod source.
int	hashCode() Generated by umod because this class is ALGEBRAIC.
DTD.Choice	initFrom(Object o0) Copies values of all common fields from the argument.
DTD.CP	modify(int modifier)
DTD.Choice	with_alts(CheckedList<DTD.CP> val) Generated by umod; model author's documentation MISSING.
boolean	x_equals(DTD.Choice e0)

Methods inherited from class eu.bandm.tools.dtd.DTD.CP

combine, get_modifier, get_modifier, with_modifier

Methods inherited from class eu.bandm.tools.dtd.DTD.ContentModel

x_equals

Methods inherited from class java.lang.Object

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

Field Detail

BASE_HASH

protected static final int BASE_HASH

alts

protected CheckedList<DTD.CP> alts

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "DTD.umod":229.7-51, cf. this pretty print.)
The type of this field is CheckedList<DTD.CP(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_alts(), with_alts(eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tools.dtd.DTD.CP>)

Constructor Detail

Choice

public Choice(int modifier,
              CheckedList<DTD.CP> alts)

Constructor generated according to specification #0
Constructor defined according to directive "C 0/..".

Parameters:

modifier - is copied to field DTD.CP.modifier

alts - is copied to field alts

Choice

public Choice(CheckedList<DTD.CP> alts)

Constructor generated according to specification #1
Constructor defined according to directive "C 1/..".

Parameters:

alts - is copied to field alts

Choice

public Choice()

Synthetic minimal constructor provided by the umod compiler.
Constructor with minimal set of arguments, supplied automatically by the umod compiler, not explicitly by user.
(All object fields are set to their default values.)

Method Detail

doclone

public DTD.Choice doclone()

Clones this object. Method never fails, since Cloneable is known to be implemented.

Overrides:

doclone in class DTD.CP

Returns:

a fresh copy.

getFormatHint

public static String getFormatHint()

Delivers the format specification from the umod source.
The constant return value is ..
alts['('|' | ',')']$switch modifier{1:'?',2:'*',3:'+'}
This can be used e.g. by format code interpreters which process objects of different origin.

format

public Format format()

Delivers a format object for pretty-printing, as specified in the umod source.

Specified by:

format in interface Formattable

Overrides:

format in class DTD.CP

modify

public DTD.CP modify(int modifier)

Overrides:

modify in class DTD.CP

equals

public boolean equals(Object e0)

Generated by umod because this class is ALGEBRAIC.

Overrides:

equals in class DTD.ContentModel

x_equals

public boolean x_equals(DTD.Choice e0)

hashCode

public int hashCode()

Generated by umod because this class is ALGEBRAIC.

Overrides:

hashCode in class DTD.ContentModel

initFrom

public DTD.Choice initFrom(Object o0)

Copies values of all common fields from the argument. All fields of this class definition are copied, iff the argument is of this class. Then the superclass method is invoked with the same argument.

Overrides:

initFrom in class DTD.CP

get_alts

public CheckedList<DTD.CP> get_alts()

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "DTD.umod":229.7-51, cf. this pretty print.)
Generated getter method. @see #alts

Returns:

The current field value of type CheckedList<DTD.CP(never null)>(never null)

with_alts

public DTD.Choice with_alts(CheckedList<DTD.CP> val)

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "DTD.umod":229.7-51, cf. this pretty print.)

Parameters:

val - the new value of type CheckedList<DTD.CP(never null)>(never null)

Returns:

a new instance of the algebraic/immutable data type, with the addressed field set to the new value.

See Also:

alts

descend_alts

public void descend_alts(DTD.MATCH_ONLY_00 visitor)

get_alts

public static Pattern<DTD.Choice> get_alts(Pattern<? super CheckedList<DTD.CP>> p)

Lifts a pattern which matches the field value to one which matches this whole object.
More complex pattern methods are generated in the one ancillary class DTD.__Patterns.