Module coneforest.psylla

Package coneforest.psylla.core

Class PsyString

java.lang.Object

coneforest.psylla.core.PsyString

All Implemented Interfaces:

PsyAppendable<PsyInteger>, PsyClearable, PsyContainer<PsyInteger>, PsyConvertableToInteger, PsyConvertableToIntegral, PsyConvertableToReal, PsyEvaluable, PsyFormalArray<PsyInteger>, PsyIndexed<PsyInteger,PsyInteger>, PsyIterable<PsyInteger>, PsyLengthy, PsyObject, PsyScalar<PsyTextual>, PsySequential<PsyInteger>, PsyStreamable<PsyInteger>, PsyTextual, Comparable<PsyTextual>, Iterable<PsyInteger>

@Type("string")
public class PsyString
extends Object
implements PsyTextual, PsyFormalArray<PsyInteger>

An implementation of string.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_STRING	Context action of the string 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.PsyConvertableToInteger

PSY_TOINTEGER

Fields inherited from interface coneforest.psylla.core.PsyConvertableToIntegral

PSY_TOINTEGRAL

Fields inherited from interface coneforest.psylla.core.PsyConvertableToReal

PSY_TOREAL

Fields inherited from interface coneforest.psylla.core.PsyEvaluable

PSY_EVAL

Fields inherited from interface coneforest.psylla.core.PsyFormalArray

PSY_EXTRACTINTERVAL, PSY_GETINTERVAL, PSY_INSERT, PSY_INSERTALL, PSY_POSTCHOP, PSY_PRECHOP, PSY_PREPEND, PSY_PREPENDALL, PSY_PUTINTERVAL, PSY_REVERSE, PSY_SETLENGTH

Fields inherited from interface coneforest.psylla.core.PsyIndexed

PSY_DELETE, PSY_ENTRIES, PSY_EXTRACT, PSY_GET, PSY_GETALL, PSY_KEYS, PSY_KNOWN, PSY_PUT, PSY_SLICE, PSY_VALUES

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.PsyScalar

PSY_CMP, PSY_GE, PSY_GT, PSY_LE, PSY_LT, PSY_MAX, PSY_MIN

Fields inherited from interface coneforest.psylla.core.PsySequential

PSY_FORALL

Fields inherited from interface coneforest.psylla.core.PsyStreamable

PSY_STREAM

Fields inherited from interface coneforest.psylla.core.PsyTextual

PSY_INDEXOFCHAR, PSY_INDEXOFSUBSTRING, PSY_LOWERCASE, PSY_SPLIT, PSY_UPPERCASE

Constructor Summary

Constructors

Constructor	Description
PsyString()	Creates a new empty string object.
PsyString(String string)	Creates a new string object whose buffer is initialized from string.
PsyString(StringBuilder buffer)	Creates a new string object with the supplied buffer.

Method Summary

Modifier and Type	Method	Description
void	delete(int index)	Removes the element at the specified position in this array.
boolean	equals(Object object)
PsyInteger	extract(int index)
PsyInteger	get(int index)	Returns the element at the specified position in this array.
StringBuilder	getBuffer()	Returns the buffer.
int	hashCode()
void	insert(int index, PsyInteger oCharacter)	Inserts the specified object into this array at the position specified by a given index.
int	length()	Returns a length of this object.
static PsyString	parseLiteral(String image)
void	psyAppend(PsyInteger oCharacter)	Appends a given object to this container.
void	psyClear()	Clear this object.
PsyString	psyClone()	Returns a clone of this object.
PsyString	psyExtractInterval(PsyInteger oStart, PsyInteger oLength)
PsyString	psyGetInterval(PsyInteger oIndex, PsyInteger oCount)
void	psyInsertAll(PsyInteger oIndex, PsyIterable<? extends PsyInteger> oIterable)
PsyString	psyLowerCase()
void	psyPutInterval(PsyInteger oIndex, PsyIterable<? extends PsyInteger> oIterable)
PsyString	psyReverse()
void	psySetLength(PsyInteger oLength)
PsyString	psySlice(PsyIterable<PsyInteger> oIndices)	Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.
PsyString	psyToString()	Returns a string representing this object.
PsyString	psyUpperCase()
void	put(int index, PsyInteger oCharacter)
String	stringValue()	Returns a string value of this object.
String	toSyntaxString()	Returns the syntactic representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface coneforest.psylla.core.PsyAppendable

psyAppendAll

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty

Methods inherited from interface coneforest.psylla.core.PsyFormalArray

psyDelete, psyEntries, psyExtract, psyGet, psyInsert, psyKeys, psyKnown, psyPostChop, psyPreChop, psyPrepend, psyPrependAll, psyPut, psyReplicate, psyValues, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyIndexed

psyGetAll

Methods inherited from interface coneforest.psylla.core.PsyIterable

psyStream, psyToArray, psyUnite

Methods inherited from interface coneforest.psylla.core.PsyLengthy

isEmpty, psyIsEmpty, psyLength

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyType, typeName

Methods inherited from interface coneforest.psylla.core.PsyScalar

psyCmp, psyGe, psyGt, psyLe, psyLt, psyMax, psyMin

Methods inherited from interface coneforest.psylla.core.PsyStreamable

psyForAll

Methods inherited from interface coneforest.psylla.core.PsyTextual

compareTo, iterator, psyEq, psyEval, psyIndexOfChar, psyIndexOfSubstring, psySplit, psyToInteger, psyToIntegral, psyToName, psyToReal

Field Details

PSY_STRING

@OperatorType("string")
public static final ContextAction PSY_STRING

Context action of the string operator.

Constructor Details

PsyString

public PsyString()

Creates a new empty string object.

PsyString

public PsyString(String string)

Creates a new string object whose buffer is initialized from string.

Parameters:

string - a string.

PsyString

public PsyString(StringBuilder buffer)

Creates a new string object with the supplied buffer.

Parameters:

buffer - a buffer.

Method Details

getBuffer

public StringBuilder getBuffer()

Returns the buffer.

Returns:

a buffer.

psyToString

public PsyString psyToString()

Description copied from interface: PsyObject

Returns a string representing this object.

Specified by:

psyToString in interface PsyObject

Returns:

a string representing this object.

stringValue

public String stringValue()

Description copied from interface: PsyTextual

Returns a string value of this object.

Specified by:

stringValue in interface PsyTextual

Returns:

a string value.

psyClone

public PsyString psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyFormalArray<PsyInteger>

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object.

get

public PsyInteger get(int index)
               throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Returns the element at the specified position in this array.

Specified by:

get in interface PsyFormalArray<PsyInteger>

Parameters:

index - the index of the element.

Returns:

the element at the specified position in this list.

Throws:

PsyRangeCheckException - if the index is out of range.

psyGetInterval

public PsyString psyGetInterval(PsyInteger oIndex,
 PsyInteger oCount)
                         throws PsyRangeCheckException

Specified by:

psyGetInterval in interface PsyFormalArray<PsyInteger>

Throws:

PsyRangeCheckException

put

public void put(int index,
 PsyInteger oCharacter)
         throws PsyRangeCheckException

Specified by:

put in interface PsyFormalArray<PsyInteger>

Throws:

PsyRangeCheckException

psyPutInterval

public void psyPutInterval(PsyInteger oIndex,
 PsyIterable<? extends PsyInteger> oIterable)
                    throws PsyRangeCheckException

Specified by:

psyPutInterval in interface PsyFormalArray<PsyInteger>

Throws:

PsyRangeCheckException

psyAppend

public void psyAppend(PsyInteger oCharacter)
               throws PsyLimitCheckException

Description copied from interface: PsyAppendable

Appends a given object to this container.

Specified by:

psyAppend in interface PsyAppendable<PsyInteger>

Parameters:

oCharacter - an object to append.

Throws:

PsyLimitCheckException - when TODO.

insert

public void insert(int index,
 PsyInteger oCharacter)
            throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Inserts the specified object into this array at the position specified by a given index.

Specified by:

insert in interface PsyFormalArray<PsyInteger>

Parameters:

index - a integer index.

oCharacter - a object.

Throws:

PsyRangeCheckException - when TODO.

psyInsertAll

public void psyInsertAll(PsyInteger oIndex,
 PsyIterable<? extends PsyInteger> oIterable)
                  throws PsyRangeCheckException

Specified by:

psyInsertAll in interface PsyFormalArray<PsyInteger>

Throws:

PsyRangeCheckException

delete

public void delete(int index)
            throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Removes the element at the specified position in this array.

Specified by:

delete in interface PsyFormalArray<PsyInteger>

Parameters:

index - the index of the element to be removed.

Throws:

PsyRangeCheckException - if the index is out of range.

extract

public PsyInteger extract(int index)
                   throws PsyRangeCheckException

Specified by:

extract in interface PsyFormalArray<PsyInteger>

Throws:

PsyRangeCheckException

psyExtractInterval

public PsyString psyExtractInterval(PsyInteger oStart,
 PsyInteger oLength)
                             throws PsyRangeCheckException

Specified by:

psyExtractInterval in interface PsyFormalArray<PsyInteger>

Throws:

PsyRangeCheckException

psySlice

public PsyString psySlice(PsyIterable<PsyInteger> oIndices)
                   throws PsyRangeCheckException,
PsyLimitCheckException

Description copied from interface: PsyIndexed

Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.

Specified by:

psySlice in interface PsyFormalArray<PsyInteger>

Specified by:

psySlice in interface PsyIndexed<PsyInteger,PsyInteger>

Parameters:

oIndices - an enumeration of keys.

Returns:

a container.

Throws:

PsyRangeCheckException - when the index is out of range.

PsyLimitCheckException - when TODO

psySetLength

public void psySetLength(PsyInteger oLength)
                  throws PsyLimitCheckException,
PsyRangeCheckException

Specified by:

psySetLength in interface PsyFormalArray<PsyInteger>

Throws:

PsyLimitCheckException

PsyRangeCheckException

psyClear

public void psyClear()

Description copied from interface: PsyClearable

Clear this object.

Specified by:

psyClear in interface PsyClearable

psyReverse

public PsyString psyReverse()

Specified by:

psyReverse in interface PsyFormalArray<PsyInteger>

psyUpperCase

public PsyString psyUpperCase()

Specified by:

psyUpperCase in interface PsyTextual

psyLowerCase

public PsyString psyLowerCase()

Specified by:

psyLowerCase in interface PsyTextual

length

public int length()

Description copied from interface: PsyLengthy

Returns a length of this object.

Specified by:

length in interface PsyLengthy

Specified by:

length in interface PsyTextual

Returns:

a length.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toSyntaxString

public String toSyntaxString()

Description copied from interface: PsyObject

Returns the syntactic representation of this object.

Specified by:

toSyntaxString in interface PsyFormalArray<PsyInteger>

Specified by:

toSyntaxString in interface PsyObject

Returns:

the syntactic representation of this object.

parseLiteral

public static PsyString parseLiteral(String image)
                              throws PsySyntaxErrorException

Throws:

PsySyntaxErrorException