gololang

Class GoloStruct

java.lang.Object

gololang.GoloStruct

All Implemented Interfaces:

java.lang.Comparable<GoloStruct>, java.lang.Iterable<Tuple>

public abstract class GoloStruct
extends java.lang.Object
implements java.lang.Iterable<Tuple>, java.lang.Comparable<GoloStruct>

Base class for Golo structure objects.

This class defines common behavior. Golo structure classes are final subclasses of this one.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	members The array of member names, initialized in Golo structure classes constructors.

Constructor Summary

Constructors

Constructor and Description
GoloStruct() Constructor that does nothing beyond calling super().

Method Summary

Modifier and Type	Method and Description
int	compareTo(GoloStruct other) Compares this structure with the specified structure for order.
abstract GoloStruct	copy() Makes a shallow copy.
Tuple	destruct() Destructuration helper.
abstract GoloStruct	frozenCopy() Makes a shallow frozen copy where any member value modification attempt will fail with an IllegalStateException.
abstract java.lang.Object	get(java.lang.String member) Gets a member value by name.
abstract boolean	isFrozen() Tells whether the instance is frozen or not.
java.util.Iterator<Tuple>	iterator() Provides an iterator over the structure.
Tuple	members() Gets the member names as a tuple of strings.
abstract GoloStruct	set(java.lang.String member, java.lang.Object value) Sets a member value by name.
abstract java.lang.Object[]	toArray() Array conversion.
Tuple	values() Gets the current values, in order of member declaration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

members

protected java.lang.String[] members

The array of member names, initialized in Golo structure classes constructors.

Constructor Detail

GoloStruct

public GoloStruct()

Constructor that does nothing beyond calling super().

Method Detail

isFrozen

public abstract boolean isFrozen()

Tells whether the instance is frozen or not.

Returns:

true if frozen, false otherwise.

members

public Tuple members()

Gets the member names as a tuple of strings.

Returns:

a tuple of member names.

values

public Tuple values()

Gets the current values, in order of member declaration.

Returns:

a tuple with the current values.

destruct

public Tuple destruct()

Destructuration helper.

Returns:

a tuple with the current values.

toArray

public abstract java.lang.Object[] toArray()

Array conversion.

Returns:

an array containing the values (in member orders)

compareTo

public int compareTo(GoloStruct other)

Compares this structure with the specified structure for order.

Returns a negative integer, zero, or a positive integer as this structure is less than, equal to, or greater than the specified structure.

Two structures are compared by comparing their values(), thus the limitations of Tuple.compareTo(gololang.Tuple) also apply.

Moreover, two structures are only comparable if they have the same type. For instance, given

 struct StructA = {x, y}
 struct StructB = {a, b}

 let aStructA = StructA(1, 2)
 let aStructB = StructB(1, 3)
 

while aStructA: values() < aStructB: values() is valid and true since we compare two 2-tuples, comparing directly the structures aStructA < aStructB throws a ClassCastException.

Specified by:

compareTo in interface java.lang.Comparable<GoloStruct>

Parameters:

other - the structure to be compared

Returns:

a negative integer, zero, or a positive integer as this structure is less than, equal to, or greater than the specified structure

Throws:

java.lang.NullPointerException - if the specified structure is null

java.lang.IllegalArgumentException - if the structure are of different type, of if the type of the members prevent them from being compared pairwise

Since:

Golo3.1

get

public abstract java.lang.Object get(java.lang.String member)

Gets a member value by name.

Parameters:

member - the member name.

Returns:

the member value.

Throws:

java.lang.IllegalArgumentException - if there is no such member member.

set

public abstract GoloStruct set(java.lang.String member,
                               java.lang.Object value)

Sets a member value by name.

Parameters:

member - the member name.

value - the value.

Returns:

this instance.

Throws:

java.lang.IllegalArgumentException - if there is no such member member.

copy

public abstract GoloStruct copy()

Makes a shallow copy.

Returns:

a copy of this structure.

frozenCopy

public abstract GoloStruct frozenCopy()

Makes a shallow frozen copy where any member value modification attempt will fail with an IllegalStateException.

Returns:

a copy of this structure.

iterator

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

Provides an iterator over the structure.

Each value is a 2-elements tuple [member, value].

Specified by:

iterator in interface java.lang.Iterable<Tuple>

Returns:

an iterator.