Package eu.bandm.tools.tpath.absy

Class TPath.Step

java.lang.Object

eu.bandm.tools.tpath.absy.TPath.Item

eu.bandm.tools.tpath.absy.TPath.Expr

eu.bandm.tools.tpath.absy.TPath.PathExpr

eu.bandm.tools.tpath.absy.TPath.Step

All Implemented Interfaces:

Formattable, Cloneable

Enclosing class:

TPath

@Generated(generator="eu.bandm.tools.umod",
           version="",
           timestamp="2026-02-01_13h19m22")
public static class TPath.Step
extends TPath.PathExpr

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":99.1-104.16, see this pretty print.)

Field Summary

Fields

Modifier and Type	Field	Description
protected TPath.AxisSpecifier	axis	Generated by umod; model author's documentation MISSING.
protected @Opt TPath.Expr	base	Generated by umod; model author's documentation MISSING.
static final Function<TPath.Step,TPath.AxisSpecifier>	get_axis	Deprecated. Use new '::' method reference instead.
static final Function<TPath.Step,@Opt TPath.Expr>	get_base	Deprecated. Use new '::' method reference instead.
static final Function<TPath.Step,NonNullList<TPath.Expr>>	get_predicates	Deprecated. Use new '::' method reference instead.
static final Function<TPath.Step,TPath.Test>	get_test	Deprecated. Use new '::' method reference instead.
protected NonNullList<TPath.Expr>	predicates	Generated by umod; model author's documentation MISSING.
protected TPath.Test	test	Generated by umod; model author's documentation MISSING.

Fields inherited from class eu.bandm.tools.tpath.absy.TPath.Expr

forced, forcing, get_forced, get_forcing

Fields inherited from class eu.bandm.tools.tpath.absy.TPath.Item

get_location, location

Constructor Summary

Constructors

Constructor	Description
Step(@Opt Location<XMLDocumentIdentifier> location, @Opt TPath.Expr base, TPath.AxisSpecifier axis, TPath.Test test, NonNullList<TPath.Expr> predicates)	Constructor defined according to directive »C 1/..«.
Step(@Opt TPath.Expr base, TPath.AxisSpecifier axis, TPath.Test test)	Constructor defined according to directive »C 0/..«.
Step(TPath.AxisSpecifier axis, TPath.Test test)	Constructor with minimal set of arguments, is supplied automatically by the umod compiler, not explicitly by the user.

Method Summary

Modifier and Type	Method	Description
void	descend_predicates(TPath.MATCH_ONLY_00 visitor)	Deprecated. Use visitor.follow_predicates(this) or visitor.followAll_predicates(this) instead.
TPath.Step	doclone()	Clones this object.
Format	format()	Delivers a format object for pretty-printing, as specified in the umod source.
TPath.AxisSpecifier	get_axis()	Generated by umod; model author's documentation MISSING.
static Pattern<TPath.Step>	get_axis(Pattern<? super TPath.AxisSpecifier> p)	Lifts a pattern which matches the field value to one which matches this whole object.
@Opt TPath.Expr	get_base()	Generated by umod; model author's documentation MISSING.
static Pattern<TPath.Step>	get_base(Pattern<? super @Opt TPath.Expr> p)	Lifts a pattern which matches the field value to one which matches this whole object.
NonNullList<TPath.Expr>	get_predicates()	Generated by umod; model author's documentation MISSING.
static Pattern<TPath.Step>	get_predicates(Pattern<? super NonNullList<TPath.Expr>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
TPath.Test	get_test()	Generated by umod; model author's documentation MISSING.
static Pattern<TPath.Step>	get_test(Pattern<? super TPath.Test> 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.
TPath.Step	initFrom(Object o0)	Copies values of all common fields from the argument.
boolean	set_axis(TPath.AxisSpecifier val)	Generated by umod; model author's documentation MISSING.
boolean	set_base(@Opt TPath.Expr val)	Generated by umod; model author's documentation MISSING.
boolean	set_predicates(NonNullList<TPath.Expr> val)	Generated by umod; model author's documentation MISSING.
boolean	set_test(TPath.Test val)	Generated by umod; model author's documentation MISSING.

Methods inherited from class eu.bandm.tools.tpath.absy.TPath.Expr

get_forced, get_forced, get_forcing, get_forcing, set_forced, set_forcing

Methods inherited from class eu.bandm.tools.tpath.absy.TPath.Item

get_location, get_location, set_location

Methods inherited from class java.lang.Object

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

Field Details

base

@Opt
protected @Opt TPath.Expr base

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":100.9-59, see this pretty print.)
The type of this field is TPath.Expr(maybe null)
Its value defaults to null.

See Also:

• get_base()
• set_base(eu.bandm.tools.tpath.absy.TPath.Expr)

get_base

@Deprecated
public static final Function<TPath.Step,@Opt TPath.Expr> get_base

Deprecated.

Use new '::' method reference instead.

axis

protected TPath.AxisSpecifier axis

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":101.9-59, see this pretty print.)
The type of this field is TPath.AxisSpecifier(never null)
It is set by every possible constructor.

See Also:

• get_axis()
• set_axis(eu.bandm.tools.tpath.absy.TPath.AxisSpecifier)

get_axis

@Deprecated
public static final Function<TPath.Step,TPath.AxisSpecifier> get_axis

Deprecated.

Use new '::' method reference instead.

test

protected TPath.Test test

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":102.9-59, see this pretty print.)
The type of this field is TPath.Test(never null)
It is set by every possible constructor.

See Also:

• get_test()
• set_test(eu.bandm.tools.tpath.absy.TPath.Test)

get_test

@Deprecated
public static final Function<TPath.Step,TPath.Test> get_test

Deprecated.

Use new '::' method reference instead.

predicates

protected NonNullList<TPath.Expr> predicates

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":103.9-59, see this pretty print.)
The type of this field is NonNullList<TPath.Expr(never null)>(never null)
Its value defaults to an empty collection.

See Also:

• get_predicates()
• set_predicates(eu.bandm.tools.util.nonnull.NonNullList<eu.bandm.tools.tpath.absy.TPath.Expr>)

get_predicates

@Deprecated
public static final Function<TPath.Step,NonNullList<TPath.Expr>> get_predicates

Deprecated.

Use new '::' method reference instead.

Constructor Details

Step

public Step(@Opt
 @Opt Location<XMLDocumentIdentifier> location,
 @Opt
 @Opt TPath.Expr base,
 TPath.AxisSpecifier axis,
 TPath.Test test,
 NonNullList<TPath.Expr> predicates)

Constructor defined according to directive »C 1/..«.

Parameters:

location - is copied to field TPath.Item.location

base - is copied to field base

axis - is copied to field axis

test - is copied to field test

predicates - is copied to field predicates

Step

public Step(@Opt
 @Opt TPath.Expr base,
 TPath.AxisSpecifier axis,
 TPath.Test test)

Constructor defined according to directive »C 0/..«.

Parameters:

base - is copied to field base

axis - is copied to field axis

test - is copied to field test

Step

public Step(TPath.AxisSpecifier axis,
 TPath.Test test)

Constructor with minimal set of arguments, is supplied automatically by the umod compiler, not explicitly by the user.

Parameters:

axis - is copied to field axis

test - is copied to field test

Method Details

doclone

public TPath.Step doclone()

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

Overrides:

doclone in class TPath.PathExpr

Returns:

a fresh copy.

getFormatHint

public static String getFormatHint()

Delivers the format specification from the umod source.
The constant return value is ..
(base'/'?),>axis'::',>test,>predicates{'['$this']'}[,]
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 TPath.PathExpr

Returns:

a format that represents this object in a pretty-printable way

initFrom

public TPath.Step 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 TPath.PathExpr

get_base

@Opt
public @Opt TPath.Expr get_base()

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":100.9-59, see this pretty print.)
Generated getter method.

Returns:

The current field value of type TPath.Expr(maybe null)

See Also:

• base

set_base

public boolean set_base(@Opt
 @Opt TPath.Expr val)

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":100.9-59, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type TPath.Expr(maybe null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• base

get_axis

public TPath.AxisSpecifier get_axis()

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":101.9-59, see this pretty print.)
Generated getter method.

Returns:

The current field value of type TPath.AxisSpecifier(never null)

See Also:

• axis

set_axis

public boolean set_axis(TPath.AxisSpecifier val)

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":101.9-59, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type TPath.AxisSpecifier(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• axis

get_test

public TPath.Test get_test()

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":102.9-59, see this pretty print.)
Generated getter method.

Returns:

The current field value of type TPath.Test(never null)

See Also:

• test

set_test

public boolean set_test(TPath.Test val)

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":102.9-59, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type TPath.Test(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• test

get_predicates

public NonNullList<TPath.Expr> get_predicates()

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":103.9-59, see this pretty print.)
Generated getter method.

Returns:

The current field value of type NonNullList<TPath.Expr(never null)>(never null)

See Also:

• predicates

set_predicates

public boolean set_predicates(NonNullList<TPath.Expr> val)

Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "TPath.umod":103.9-59, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type NonNullList<TPath.Expr(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• predicates

descend_predicates

@Deprecated
public void descend_predicates(TPath.MATCH_ONLY_00 visitor)

Deprecated.

Use visitor.follow_predicates(this) or visitor.followAll_predicates(this) instead.

get_base

public static Pattern<TPath.Step> get_base(Pattern<? super @Opt TPath.Expr> 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 TPath.__Patterns.

get_axis

public static Pattern<TPath.Step> get_axis(Pattern<? super TPath.AxisSpecifier> 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 TPath.__Patterns.

get_test

public static Pattern<TPath.Step> get_test(Pattern<? super TPath.Test> 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 TPath.__Patterns.

get_predicates

public static Pattern<TPath.Step> get_predicates(Pattern<? super NonNullList<TPath.Expr>> 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 TPath.__Patterns.