Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyFormalSet<T extends PsyObject>

Type Parameters:

T - a type of the elements.

All Superinterfaces:

Iterable<T>, PsyAppendable<T>, PsyClearable, PsyContainer<T>, PsyIterable<T>, PsyLengthy, PsyObject, PsySequential<T>, PsyStreamable<T>

All Known Implementing Classes:

PsyBitSet, PsySet

@Type("formalset")
public interface PsyFormalSet<T extends PsyObject>
extends PsyAppendable<T>, PsyContainer<T>

The representation of a formalset, an abstraction of a finite set of objects. This interface declares methods for appending, removal and set operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_CONTAINS	Context action of the contains operator.
static final ContextAction	PSY_INTERSECTS	Context action of the intersects operator.
static final ContextAction	PSY_REMOVE	Context action of the remove operator.
static final ContextAction	PSY_REMOVEALL	Context action of the removeall operator.
static final ContextAction	PSY_RETAINALL	Context action of the retainall operator.

Fields inherited from interface coneforest.psylla.core.PsyAppendable

PSY_APPEND, PSY_APPENDALL

Fields inherited from interface coneforest.psylla.core.PsyClearable

PSY_CLEAR

Fields inherited from interface coneforest.psylla.core.PsyLengthy

PSY_ISEMPTY, PSY_LENGTH

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TONAME, PSY_TOSTRING, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsySequential

PSY_FORALL

Fields inherited from interface coneforest.psylla.core.PsyStreamable

PSY_STREAM

Method Summary

Modifier and Type	Method	Description
default void	psyAppendAll(PsyIterable<? extends T> oEnumeration)	Appends all the objects from a given iterable enumeration to this set.
default void	psyClear()	Removes all the elements from this set.
PsyBoolean	psyContains(T o)	Returns a boolean object indicating whether a given object belongs to this set.
default PsyBoolean	psyIntersects(PsyFormalSet<? extends T> oSet)	Returns a boolean object indicating whether a given formalset set intersects with this set.
void	psyRemove(T o)	Removes an object from this set.
default void	psyRemoveAll(PsyIterable<? extends T> oEnumeration)	Removes all the objects in a given iterable enumeration from this set.
default PsyFormalSet<T>	psyReplicate(PsyInteger oCount)
default void	psyRetainAll(PsyIterable<? extends T> oEnumeration)
default String	toSyntaxString()	Returns the syntactic representation of this object.
default String	toSyntaxStringHelper(PsyLengthy oLengthy)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface coneforest.psylla.core.PsyAppendable

psyAppend

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyIterable

psyStream, psyToArray, psyUnite

Methods inherited from interface coneforest.psylla.core.PsyLengthy

isEmpty, length, psyIsEmpty, psyLength

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, typeName

Methods inherited from interface coneforest.psylla.core.PsyStreamable

psyForAll

Field Details

PSY_CONTAINS

@OperatorType("contains")
static final ContextAction PSY_CONTAINS

Context action of the contains operator.

PSY_INTERSECTS

@OperatorType("intersects")
static final ContextAction PSY_INTERSECTS

Context action of the intersects operator.

PSY_REMOVE

@OperatorType("remove")
static final ContextAction PSY_REMOVE

Context action of the remove operator.

PSY_REMOVEALL

@OperatorType("removeall")
static final ContextAction PSY_REMOVEALL

Context action of the removeall operator.

PSY_RETAINALL

@OperatorType("retainall")
static final ContextAction PSY_RETAINALL

Context action of the retainall operator.

Method Details

psyRemove

void psyRemove(T o)

Removes an object from this set. If a given object is not present in this set, error does not occur.

Parameters:

o - an object.

psyRemoveAll

default void psyRemoveAll(PsyIterable<? extends T> oEnumeration)

Removes all the objects in a given iterable enumeration from this set. If some object is not present in this set, error does not occur.

Parameters:

oEnumeration - an iterable enumeration.

psyRetainAll

default void psyRetainAll(PsyIterable<? extends T> oEnumeration)
                   throws PsyErrorException

Throws:

PsyErrorException

psyContains

PsyBoolean psyContains(T o)

Returns a boolean object indicating whether a given object belongs to this set.

Parameters:

o - an object.

Returns:

boolean indicating whether an object belongs to this set.

psyClear

default void psyClear()

Removes all the elements from this set.

Specified by:

psyClear in interface PsyClearable

psyAppendAll

default void psyAppendAll(PsyIterable<? extends T> oEnumeration)
                   throws PsyLimitCheckException,
PsyRangeCheckException

Appends all the objects from a given iterable enumeration to this set. When a given enumeration is the same as this set, first clone the enumeration, and then appends all the elements from the clone.

Specified by:

psyAppendAll in interface PsyAppendable<T extends PsyObject>

Parameters:

oEnumeration - an iterable enumeration.

Throws:

PsyLimitCheckException - when TODO.

PsyRangeCheckException - when TODO.

psyIntersects

default PsyBoolean psyIntersects(PsyFormalSet<? extends T> oSet)

Returns a boolean object indicating whether a given formalset set intersects with this set.

Parameters:

oSet - a formalset set.

Returns:

boolean indicating whether a given formalset intersects with this set.

psyReplicate

default PsyFormalSet<T> psyReplicate(PsyInteger oCount)
                              throws PsyLimitCheckException,
PsyRangeCheckException,
PsyUnsupportedException

Specified by:

psyReplicate in interface PsyAppendable<T extends PsyObject>

Throws:

PsyLimitCheckException

PsyRangeCheckException

PsyUnsupportedException

toSyntaxString

default String toSyntaxString()

Description copied from interface: PsyObject

Returns the syntactic representation of this object.

Specified by:

toSyntaxString in interface PsyObject

Returns:

the syntactic representation of this object.

toSyntaxStringHelper

default String toSyntaxStringHelper(PsyLengthy oLengthy)