io.opsit.explang

Class Seq

java.lang.Object

io.opsit.explang.Seq

public class Seq
extends Object

Utility class for operations on sequences of various types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Seq.Multiop
static interface	Seq.Operation
protected static interface	Seq.SeqAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected static Seq.SeqAdapter	arrayAdapter
protected static Seq.SeqAdapter	charSequenceAdapter
protected static Seq.SeqAdapter	immutableListAdapter
protected static Seq.SeqAdapter	immutableMapAdapter
protected static Seq.SeqAdapter	immutableSetAdapter
protected static Seq.SeqAdapter	listAdapter
protected static Seq.SeqAdapter	mapAdapter
protected static Seq.SeqAdapter	nullAdapter
protected static Seq.SeqAdapter	setAdapter
protected static Seq.SeqAdapter	stringAdapter
protected static Seq.SeqAdapter	stringBufferAdapter
protected static Seq.SeqAdapter	stringBuilderAdapter

Constructor Summary

Constructors

Constructor and Description
Seq()

Method Summary

Modifier and Type	Method and Description
static Object	addValue(Object seq, Object value) Add value to sequence.
static Set<?>	asSet(Object obj) Return sequence objects as Set.
static boolean	containsElement(Object seq, Object obj) Check if sequence contains object.
static boolean	containsKey(Object seq, Object key) Check if an associative collection contains key.
static boolean	doGet(Object obj, Object[] result, Object keyObj) Get data object from nested data structures.
static Object	doGetIn(Object obj, Object ksObj, int ksIdx, Object notDefined) Get data object from nested data structures.
static int	forEach(Object seq, Seq.Operation op, boolean allowNonSeq) Run operation op on all objects in sequence.
protected static Seq.SeqAdapter	getAssociativeSeqAdapter(Object seq)
static Object	getElementByIndex(Object seq, int index) Get sequence element by index.
static Object	getElementByKeyOrIndex(Object seq, Object key) Get sequence element by key.
protected static int	getIntIdx(Object key)
protected static Object	getKeyByIndex(Object ksObj, int ksIdx)
static int	getLength(Object val, boolean allowNonSeq) Get length of sequence.
protected static Seq.SeqAdapter	getSeqAdapter(Object seq)
static Object	insertElementByIndex(Object seq, int index, Object element) put sequence element by index.
static boolean	isAssociative(Object obj) Check if object supports associative addressing (indices or keys).
static boolean	isCollection(Object obj) Check if object is a supported collection.
static boolean	isIndexed(Object obj) Check if object is an indexed sequence.
static boolean	isMap(Object obj) Check if object is a set.
static boolean	isSeq(Object obj) Check if object is a supported sequence.
static boolean	isSet(Object obj) Check if object is a set.
static String	joinWithString(Object seqObj, String sep) Join sequence with string separator.
static List<Object>	mapall(Seq.Multiop op, Object... seqs) Perform operation on all objects of the given sequences.
static int	maxLength(Object... seqs) Get maximal length of given sequences.
static int	minLength(Object... seqs) Get minimal length of given sequences.
static Object	putElement(Object seq, Object key, Object element) Put element into associative structure by key or index.
static Object	putToMap(Map<Object,Object> m, Object key, Object value)
static Object	refElementByIndex(Object seq, int index) Get sequence element by index.
static Object	removeElementByIndex(Object seq, int index) Remove sequence element by index.
static Object	removeElementByKeyOrIndex(Object seq, Object key) Remove element from sequence by key or index.
static Object	removeLastElement(Object seq) Remove last element of indexed sequence or arbitrary from a set.
static Object	roAddValue(Object seq, Object value)
static Object	roInsertElementByIndex(Object seq, int index, Object element) Put sequence element by index.
static Object	roPutElement(Object seq, Object key, Object element) put sequence element by key.
static Object	roPutToMap(Map<Object,Object> m, Object key, Object value)
static Object	roRemoveElementByKeyOrIndex(Object seq, Object key) Remove element from sequence by key or index.
static List<Object>	roRemoveLastElement(Object seq) Non-mutating remove last element.
static Object	roSetElementByIndex(Object seq, int index, Object element)
static boolean	sequal(Map<?,?> m1, Map<?,?> m2) Compare maps contents.
static boolean	sequal(Object o1, Object o2) Compare objects, for sequences compare sequence contents.
static Object	setElement(Object seq, Object key, Object element) put sequence element by key.
static Object	setElementByIndex(Object seq, int index, Object element) put sequence element by index.
static Object	shallowClone(Object seq)
static List<Object>	valuesList(Object seq) Return new list with all elements of given sequence.

Methods inherited from class java.lang.Object

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

Field Detail

listAdapter

protected static final Seq.SeqAdapter listAdapter

immutableListAdapter

protected static final Seq.SeqAdapter immutableListAdapter

immutableSetAdapter

protected static final Seq.SeqAdapter immutableSetAdapter

setAdapter

protected static final Seq.SeqAdapter setAdapter

stringBufferAdapter

protected static final Seq.SeqAdapter stringBufferAdapter

stringBuilderAdapter

protected static final Seq.SeqAdapter stringBuilderAdapter

stringAdapter

protected static final Seq.SeqAdapter stringAdapter

charSequenceAdapter

protected static final Seq.SeqAdapter charSequenceAdapter

arrayAdapter

protected static final Seq.SeqAdapter arrayAdapter

mapAdapter

protected static final Seq.SeqAdapter mapAdapter

immutableMapAdapter

protected static final Seq.SeqAdapter immutableMapAdapter

nullAdapter

protected static final Seq.SeqAdapter nullAdapter

Constructor Detail

Seq

public Seq()

Method Detail

isCollection

public static boolean isCollection(Object obj)

Check if object is a supported collection.

isSeq

public static boolean isSeq(Object obj)

Check if object is a supported sequence.

isIndexed

public static boolean isIndexed(Object obj)

Check if object is an indexed sequence.

isSet

public static boolean isSet(Object obj)

Check if object is a set.

isMap

public static boolean isMap(Object obj)

Check if object is a set.

isAssociative

public static boolean isAssociative(Object obj)

Check if object supports associative addressing (indices or keys).

forEach

public static int forEach(Object seq,
                          Seq.Operation op,
                          boolean allowNonSeq)

Run operation op on all objects in sequence.

If allowNonSeq is true then run operation on object that is not a sequence.

containsKey

public static boolean containsKey(Object seq,
                                  Object key)

Check if an associative collection contains key.

containsElement

public static boolean containsElement(Object seq,
                                      Object obj)

Check if sequence contains object.

getElementByKeyOrIndex

public static Object getElementByKeyOrIndex(Object seq,
                                            Object key)

Get sequence element by key.

removeLastElement

public static Object removeLastElement(Object seq)

Remove last element of indexed sequence or arbitrary from a set. Returns null if no elements left.

roRemoveLastElement

public static List<Object> roRemoveLastElement(Object seq)

Non-mutating remove last element.

removeElementByKeyOrIndex

public static Object removeElementByKeyOrIndex(Object seq,
                                               Object key)

Remove element from sequence by key or index.

roRemoveElementByKeyOrIndex

public static Object roRemoveElementByKeyOrIndex(Object seq,
                                                 Object key)

Remove element from sequence by key or index.

addValue

public static Object addValue(Object seq,
                              Object value)

Add value to sequence.

roAddValue

public static Object roAddValue(Object seq,
                                Object value)

getSeqAdapter

protected static Seq.SeqAdapter getSeqAdapter(Object seq)

getAssociativeSeqAdapter

protected static Seq.SeqAdapter getAssociativeSeqAdapter(Object seq)

shallowClone

public static Object shallowClone(Object seq)

getElementByIndex

public static Object getElementByIndex(Object seq,
                                       int index)

Get sequence element by index. Ignore index errors.

refElementByIndex

public static Object refElementByIndex(Object seq,
                                       int index)

Get sequence element by index. Throws IndexOutOfBounds exception if index is invalid.

removeElementByIndex

public static Object removeElementByIndex(Object seq,
                                          int index)

Remove sequence element by index.

putElement

public static Object putElement(Object seq,
                                Object key,
                                Object element)

Put element into associative structure by key or index. Returns previous value of the entry. In case of IndexOutOfBoundsException does not modify the structure and returns null.

roPutElement

public static Object roPutElement(Object seq,
                                  Object key,
                                  Object element)

put sequence element by key. Return old value at this index.

putToMap

public static Object putToMap(Map<Object,Object> m,
                              Object key,
                              Object value)

roPutToMap

public static Object roPutToMap(Map<Object,Object> m,
                                Object key,
                                Object value)

roSetElementByIndex

public static Object roSetElementByIndex(Object seq,
                                         int index,
                                         Object element)

setElementByIndex

public static Object setElementByIndex(Object seq,
                                       int index,
                                       Object element)
                                throws IndexOutOfBoundsException

put sequence element by index. Return old value at this index.

Throws:

IndexOutOfBoundsException

insertElementByIndex

public static Object insertElementByIndex(Object seq,
                                          int index,
                                          Object element)
                                   throws IndexOutOfBoundsException

put sequence element by index. Return old value at this index.

Throws:

IndexOutOfBoundsException

roInsertElementByIndex

public static Object roInsertElementByIndex(Object seq,
                                            int index,
                                            Object element)
                                     throws IndexOutOfBoundsException

Put sequence element by index. Return copy of the target object with the change applied.

Throws:

IndexOutOfBoundsException

setElement

public static Object setElement(Object seq,
                                Object key,
                                Object element)
                         throws IndexOutOfBoundsException

put sequence element by key. Return old value at this index.

Throws:

IndexOutOfBoundsException

getLength

public static int getLength(Object val,
                            boolean allowNonSeq)

Get length of sequence.

asSet

public static Set<?> asSet(Object obj)

Return sequence objects as Set.

valuesList

public static List<Object> valuesList(Object seq)

Return new list with all elements of given sequence.

maxLength

public static int maxLength(Object... seqs)

Get maximal length of given sequences.

minLength

public static int minLength(Object... seqs)

Get minimal length of given sequences.

mapall

public static List<Object> mapall(Seq.Multiop op,
                                  Object... seqs)

Perform operation on all objects of the given sequences.

sequal

public static boolean sequal(Map<?,?> m1,
                             Map<?,?> m2)

Compare maps contents.

sequal

public static boolean sequal(Object o1,
                             Object o2)

Compare objects, for sequences compare sequence contents.

doGet

public static boolean doGet(Object obj,
                            Object[] result,
                            Object keyObj)

Get data object from nested data structures.

doGetIn

public static Object doGetIn(Object obj,
                             Object ksObj,
                             int ksIdx,
                             Object notDefined)

Get data object from nested data structures.

getKeyByIndex

protected static Object getKeyByIndex(Object ksObj,
                                      int ksIdx)

getIntIdx

protected static int getIntIdx(Object key)

joinWithString

public static String joinWithString(Object seqObj,
                                    String sep)

Join sequence with string separator.