Package com.igormaznitsa.prologparser.terms

Class PrologStruct

java.lang.Object

com.igormaznitsa.prologparser.terms.PrologTerm

com.igormaznitsa.prologparser.terms.PrologCompound

com.igormaznitsa.prologparser.terms.PrologStruct

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PrologTerm>, java.lang.Iterable<PrologTerm>

Direct Known Subclasses:

PrologList

public class PrologStruct
extends PrologCompound
implements java.lang.Iterable<PrologTerm>

Representation of prolog structure.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PrologTerm[]	elements
static PrologAtom	EMPTY_ATOM
protected PrologTerm	functor
private static long	serialVersionUID

Fields inherited from class com.igormaznitsa.prologparser.terms.PrologTerm

quotation, text

Constructor Summary

Constructors

Modifier	Constructor	Description
	PrologStruct(PrologTerm functor)
protected	PrologStruct(PrologTerm functor, int arity)
	PrologStruct(PrologTerm functor, int line, int pos)
protected	PrologStruct(PrologTerm functor, int arity, int line, int pos)
	PrologStruct(PrologTerm functor, PrologTerm[] elements)
	PrologStruct(PrologTerm functor, PrologTerm[] elements, int line, int pos)
	PrologStruct(java.lang.String text)
	PrologStruct(java.lang.String text, int line, int pos)

Method Summary

Modifier and Type	Method	Description
private static PrologTerm	assertFunctor(PrologTerm functor)
PrologStruct	copyWithAnotherFunctor(PrologTerm newFunctor)	Make copy of the structure with replacement of functor.
java.util.List<PrologTerm>	flatComma(java.util.List<PrologTerm> list)	Flat content of the term for comma, make sense for structures.
int	getArity()	Arity of element.
PrologTerm	getFunctor()	Get the functor, make sense of structure and its successors, for primitive returns the same term.
int	getPrecedence()	Get precedence of the term.
PrologTerm	getTermAt(int index)	Get element for its position
TermType	getType()	Get term type.
boolean	isAnyBlock()	Check the term describes '()' or '{}' block.
boolean	isBlock()	Check the term describes '()' block.
boolean	isCurlyBlock()	Check the term describes '{}' block.
boolean	isEmpty()	Check that the structure has elements.
java.util.Iterator<PrologTerm>	iterator()
void	setElementAt(int index, PrologTerm term)	Set element for its position.
java.util.stream.Stream<PrologTerm>	stream()
java.lang.String	toString()

Methods inherited from class com.igormaznitsa.prologparser.terms.PrologTerm

assertNonEmptyString, compareTo, findQuotation, getLine, getPos, getQuotation, getText, setLine, setPos

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY_ATOM

public static final PrologAtom EMPTY_ATOM

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

functor

protected final PrologTerm functor

elements

protected final PrologTerm[] elements

Constructor Detail

PrologStruct

public PrologStruct(PrologTerm functor,
                    PrologTerm[] elements)

PrologStruct

public PrologStruct(PrologTerm functor,
                    PrologTerm[] elements,
                    int line,
                    int pos)

PrologStruct

public PrologStruct(java.lang.String text)

PrologStruct

public PrologStruct(java.lang.String text,
                    int line,
                    int pos)

PrologStruct

public PrologStruct(PrologTerm functor)

PrologStruct

public PrologStruct(PrologTerm functor,
                    int line,
                    int pos)

PrologStruct

protected PrologStruct(PrologTerm functor,
                       int arity)

PrologStruct

protected PrologStruct(PrologTerm functor,
                       int arity,
                       int line,
                       int pos)

Method Detail

assertFunctor

private static PrologTerm assertFunctor(PrologTerm functor)

getType

public TermType getType()

Description copied from class: PrologTerm

Get term type.

Specified by:

getType in class PrologTerm

Returns:

term type, must not be null

getArity

public int getArity()

Description copied from class: PrologTerm

Arity of element.

Overrides:

getArity in class PrologTerm

Returns:

arity of element, make sense for compound terms, for primitive terms is 1

getTermAt

public PrologTerm getTermAt(int index)

Description copied from class: PrologCompound

Get element for its position

Specified by:

getTermAt in class PrologCompound

Parameters:

index - zero-based element position

Returns:

element in position

setElementAt

public void setElementAt(int index,
                         PrologTerm term)

Set element for its position.

Parameters:

index - zero based index

term - term to set to position

Throws:

java.lang.ArrayIndexOutOfBoundsException - if wrong index

getFunctor

public PrologTerm getFunctor()

Description copied from class: PrologTerm

Get the functor, make sense of structure and its successors, for primitive returns the same term.

Overrides:

getFunctor in class PrologTerm

Returns:

functor for structure or the same term

getPrecedence

public int getPrecedence()

Description copied from class: PrologTerm

Get precedence of the term.

Overrides:

getPrecedence in class PrologTerm

Returns:

precedence, must not be negative

copyWithAnotherFunctor

public PrologStruct copyWithAnotherFunctor(PrologTerm newFunctor)

Make copy of the structure with replacement of functor.

Parameters:

newFunctor - the new functor, must not be null

Returns:

the new instance with replaced functor.

isAnyBlock

public boolean isAnyBlock()

Description copied from class: PrologTerm

Check the term describes '()' or '{}' block.

Overrides:

isAnyBlock in class PrologTerm

Returns:

true if the term is structure describes any kind of supported block

isCurlyBlock

public boolean isCurlyBlock()

Description copied from class: PrologTerm

Check the term describes '{}' block.

Overrides:

isCurlyBlock in class PrologTerm

Returns:

true if the term is structure with '{}' as functor

isBlock

public boolean isBlock()

Description copied from class: PrologTerm

Check the term describes '()' block.

Overrides:

isBlock in class PrologTerm

Returns:

true if the term is structure with '()' as functor

flatComma

public java.util.List<PrologTerm> flatComma(java.util.List<PrologTerm> list)

Description copied from class: PrologTerm

Flat content of the term for comma, make sense for structures.

Overrides:

flatComma in class PrologTerm

Parameters:

list - list to be filled by comma separated terms

Returns:

the same list

toString

public java.lang.String toString()

Overrides:

toString in class PrologTerm

isEmpty

public boolean isEmpty()

Check that the structure has elements.

Returns:

true if there is not elements, false otherwise

stream

public java.util.stream.Stream<PrologTerm> stream()

Overrides:

stream in class PrologTerm

iterator

public java.util.Iterator<PrologTerm> iterator()

Specified by:

iterator in interface java.lang.Iterable<PrologTerm>