Package com.igormaznitsa.prologparser.terms

Class OpContainer

java.lang.Object

com.igormaznitsa.prologparser.terms.PrologTerm

com.igormaznitsa.prologparser.terms.PrologCompound

com.igormaznitsa.prologparser.terms.InternalSpecialCompoundTerm

com.igormaznitsa.prologparser.terms.OpContainer

All Implemented Interfaces:

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

public final class OpContainer
extends InternalSpecialCompoundTerm

Container of operators which have same name but differently associative.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private int	numberAtContainer
private Op	opFZ
private Op	opZF
private Op	opZFZ
private static long	serialVersionUID

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

quotation, text

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OpContainer(Op operator)
private	OpContainer(java.lang.String text, Op fz, Op zf, Op zfz)

Method Summary

Modifier and Type	Method	Description
boolean	add(Op operator)	Add operator into the container.
void	clear()	Remove all saved operators.
Op	findForArity(int arity)	Find operator with arity in the container
Op	findForType(OpAssoc type)	Find operator for its type
Op	findSimilar(boolean hasLeftArg, boolean hasRightArg)	Find operator for presented arguments.
Op	findSimilar(OpAssoc type)	Find operator with similar type.
int	getArity()	Arity of element.
Op	getIfSingle()	Get operator if it is only one in the container
int	getPrecedence()	Get precedence of the term.
PrologTerm	getTermAt(int position)	Get element for its position
TermType	getType()	Get term type.
static OpContainer	make(Op operator)	Create new container based on operator name.
static OpContainer	make(java.lang.String text, Op fz, Op zf, Op zfz)
boolean	remove(Op op)	Remove operator from the container
boolean	removeForType(OpAssoc type)	Remove operator for type
int	size()	Get current size of the container.
java.lang.String	toString()

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

compareTo, stream

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

assertNonEmptyString, findQuotation, flatComma, getFunctor, getLine, getPos, getQuotation, getText, isAnyBlock, isBlock, isCurlyBlock, setLine, setPos

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

opFZ

private Op opFZ

opZF

private Op opZF

opZFZ

private Op opZFZ

numberAtContainer

private int numberAtContainer

Constructor Detail

OpContainer

private OpContainer(Op operator)

OpContainer

private OpContainer(java.lang.String text,
                    Op fz,
                    Op zf,
                    Op zfz)

Method Detail

make

public static OpContainer make(Op operator)

Create new container based on operator name.

Parameters:

operator - operator which name will be used and which will be added to the new container

Returns:

generated container with the operator

make

public static OpContainer make(java.lang.String text,
                               Op fz,
                               Op zf,
                               Op zfz)

add

public boolean add(Op operator)

Add operator into the container.

Parameters:

operator - the operator to be added

Returns:

true if the operator has been added, false if it was impossible because similar operator already presented

Throws:

java.lang.IllegalArgumentException - if operator has different name

clear

public void clear()

Remove all saved operators.

findForArity

public Op findForArity(int arity)

Find operator with arity in the container

Parameters:

arity - arity to be used (1..2)

Returns:

found operator or null

remove

public boolean remove(Op op)

Remove operator from the container

Parameters:

op - operator to be removed

Returns:

true if operator was removed, false otherwise

Throws:

java.lang.IllegalArgumentException - if operator name is not compatible with the container

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 position)

Description copied from class: PrologCompound

Get element for its position

Overrides:

getTermAt in class InternalSpecialCompoundTerm

Parameters:

position - zero-based element position

Returns:

element in position

size

public int size()

Get current size of the container.

Returns:

size of the container

getIfSingle

public Op getIfSingle()

Get operator if it is only one in the container

Returns:

the found only operator, null if there are severe operators

findSimilar

public Op findSimilar(boolean hasLeftArg,
                      boolean hasRightArg)

Find operator for presented arguments.

Parameters:

hasLeftArg - should have left argument

hasRightArg - should have right argument

Returns:

operator for needed condition, null if not found

findForType

public Op findForType(OpAssoc type)

Find operator for its type

Parameters:

type - type of needed operator

Returns:

found operator, null if not found

findSimilar

public Op findSimilar(OpAssoc type)

Find operator with similar type. For instance FX is similar to FY and XF is similar to YF.

Parameters:

type - type of operator to find

Returns:

operator with similar type or null if not found

removeForType

public boolean removeForType(OpAssoc type)

Remove operator for type

Parameters:

type - type of removing operator

Returns:

true if removed, false if not found

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

toString

public java.lang.String toString()

Overrides:

toString in class PrologTerm