|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ericsson.otp.erlang.OtpErlangObject com.ericsson.otp.erlang.OtpErlangTuple
public class OtpErlangTuple
Provides a Java representation of Erlang tuples. Tuples are created from one or more arbitrary Erlang terms.
The arity of the tuple is the number of elements it contains. Elements are indexed from 0 to (arity-1) and can be retrieved individually by using the appropriate index.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.ericsson.otp.erlang.OtpErlangObject |
---|
OtpErlangObject.Hash |
Field Summary |
---|
Fields inherited from class com.ericsson.otp.erlang.OtpErlangObject |
---|
hashCodeValue |
Constructor Summary | |
---|---|
OtpErlangTuple(OtpErlangObject elem)
Create a unary tuple containing the given element. |
|
OtpErlangTuple(OtpErlangObject[] elems)
Create a tuple from an array of terms. |
|
OtpErlangTuple(OtpErlangObject[] elems,
int start,
int count)
Create a tuple from an array of terms. |
|
OtpErlangTuple(OtpInputStream buf)
Create a tuple from a stream containing an tuple encoded in Erlang external format. |
Method Summary | ||
---|---|---|
int |
arity()
Get the arity of the tuple. |
|
|
bind(T binds)
Make new Erlang term replacing variables with the respective values from bindings argument(s). |
|
java.lang.Object |
clone()
|
|
protected int |
doHashCode()
|
|
OtpErlangObject |
elementAt(int i)
Get the specified element from the tuple. |
|
OtpErlangObject[] |
elements()
Get all the elements from the tuple as an array. |
|
void |
encode(OtpOutputStream buf)
Convert this tuple to the equivalent Erlang external representation. |
|
boolean |
equals(java.lang.Object o)
Determine if two tuples are equal. |
|
|
match(OtpErlangObject term,
T bindings)
Perform match operation against given term. |
|
java.lang.String |
toString()
Get the string representation of the tuple. |
Methods inherited from class com.ericsson.otp.erlang.OtpErlangObject |
---|
decode, hashCode |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public OtpErlangTuple(OtpErlangObject elem)
elem
- the element to create the tuple from.
java.lang.IllegalArgumentException
- if the element is null.public OtpErlangTuple(OtpErlangObject[] elems)
elems
- the array of terms to create the tuple from.
java.lang.IllegalArgumentException
- if the array is empty (null) or contains null elements.public OtpErlangTuple(OtpErlangObject[] elems, int start, int count)
elems
- the array of terms to create the tuple from.start
- the offset of the first term to insert.count
- the number of terms to insert.
java.lang.IllegalArgumentException
- if the array is empty (null) or contains null elements.public OtpErlangTuple(OtpInputStream buf) throws OtpErlangDecodeException
buf
- the stream containing the encoded tuple.
OtpErlangDecodeException
- if the buffer does not contain a valid external
representation of an Erlang tuple.Method Detail |
---|
public int arity()
public OtpErlangObject elementAt(int i)
i
- the index of the requested element. Tuple elements are
numbered as array elements, starting at 0.
public OtpErlangObject[] elements()
public java.lang.String toString()
toString
in class OtpErlangObject
public void encode(OtpOutputStream buf)
encode
in class OtpErlangObject
buf
- an output stream to which the encoded tuple should be written.public boolean equals(java.lang.Object o)
equals
in class OtpErlangObject
o
- the tuple to compare to.
public <T> boolean match(OtpErlangObject term, T bindings)
OtpErlangObject
match
in class OtpErlangObject
term
- the object to matchbindings
- variable bindings
public <T> OtpErlangObject bind(T binds) throws OtpErlangException
OtpErlangObject
bind
in class OtpErlangObject
binds
- variable bindings
OtpErlangException
protected int doHashCode()
doHashCode
in class OtpErlangObject
public java.lang.Object clone()
clone
in class OtpErlangObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |