Struct (rdl-java 1.5.4 API)

java.lang.Object
- com.yahoo.rdl.Struct

All Implemented Interfaces:

Iterable<Struct.Field>, Map<String,Object>
```
public class Struct
extends Object
implements Iterable<Struct.Field>, Map<String,Object>
```
A Struct is a structured value, with named fields. A mapping of string names to values is maintained, with a predictable order. Because the field order is definite, Structs congruent with each other can be compared to produce a definite order.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Struct.Field

class Struct.TypedArrayIterable<T>

class Struct.TypedArrayIterator<T>

Nested Classes
Modifier and Type	Class and Description
`class`	`Struct.Field`
`class`	`Struct.TypedArrayIterable<T>`
`class`	`Struct.TypedArrayIterator<T>`

Constructor Summary

Constructors
Constructor and Description

Struct()

Struct(int cap)

Constructors
Constructor and Description
`Struct()`
`Struct(int cap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(String name, Object val)` An optimized appender.
`void`	`clear()`
`boolean`	`containsKey(Object name)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object another)`
`Object`	`get(Object name)`
`Object`	`get(String name)`
`boolean`	`getBoolean(String name)`
`boolean`	`getBoolean(String name, boolean defaultValue)`
`byte`	`getByte(String name)`
`byte`	`getByte(String name, byte defaultValue)`
`byte[]`	`getBytes(String name)`
`double`	`getDouble(String name)`
`double`	`getDouble(String name, double defaultValue)`
`float`	`getFloat(String name)`
`float`	`getFloat(String name, float defaultValue)`
`int`	`getInt(String name)`
`int`	`getInt(String name, int defaultValue)`
`long`	`getLong(String name)`
`long`	`getLong(String name, long defaultValue)`
`short`	`getShort(String name)`
`short`	`getShort(String name, short defaultValue)`
`String`	`getString(String name)`
`String`	`getString(String name, String defaultValue)`
`Struct`	`getStruct(String name)`
`Timestamp`	`getTimestamp(String name)`
`UUID`	`getUUID(String name)`
`boolean`	`has(String name)`
`boolean`	`isEmpty()`
`Iterator<Struct.Field>`	`iterator()`
`Set<String>`	`keySet()`
`Iterable<String>`	`names()`
`Object`	`put(String name, Object val)`
`void`	`putAll(Map<? extends String,? extends Object> m)`
`Object`	`remove(Object name)`
`Object`	`remove(String name)`
`int`	`size()`
`String[]`	`sortedNames()`
`String`	`toString()`
`Collection<Object>`	`values()`
`Struct`	`with(String key, Object val)`
`Struct`	`with(Struct another)`
`Struct`	`withNonNull(String key, Object val)`
`Struct`	`without(String key)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Struct
```
public Struct(int cap)
```

Struct
```
public Struct()
```

Method Detail

size
```
public int size()
```
Specified by:

size in interface Map<String,Object>

isEmpty
```
public boolean isEmpty()
```
Specified by:

isEmpty in interface Map<String,Object>

names
```
public Iterable<String> names()
```

values
```
public Collection<Object> values()
```
Specified by:

values in interface Map<String,Object>

iterator
```
public Iterator<Struct.Field> iterator()
```
Specified by:

iterator in interface Iterable<Struct.Field>

append
```
public void append(String name,
                   Object val)
```
An optimized appender. Be careful to not introduce duplicate names!

Parameters:

name - the field name

val - the field value

put

public Object put(String name,
                  Object val)

Specified by:: put in interface Map<String,Object>

remove
```
public Object remove(Object name)
```
Specified by:

remove in interface Map<String,Object>

remove
```
public Object remove(String name)
```

putAll

public void putAll(Map<? extends String,? extends Object> m)

Specified by:: putAll in interface Map<String,Object>

with

public Struct with(String key,
                   Object val)

withNonNull

public Struct withNonNull(String key,
                          Object val)

with
```
public Struct with(Struct another)
```

without
```
public Struct without(String key)
```

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object another)
```
Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

has
```
public boolean has(String name)
```

sortedNames
```
public String[] sortedNames()
```

get
```
public Object get(String name)
```

getBoolean

public boolean getBoolean(String name,
                          boolean defaultValue)

getBoolean

public boolean getBoolean(String name)

getByte

public byte getByte(String name,
                    byte defaultValue)

getByte
```
public byte getByte(String name)
```

getShort

public short getShort(String name,
                      short defaultValue)

getShort
```
public short getShort(String name)
```

getInt

public int getInt(String name,
                  int defaultValue)

getInt
```
public int getInt(String name)
```

getLong

public long getLong(String name,
                    long defaultValue)

getLong
```
public long getLong(String name)
```

getFloat

public float getFloat(String name,
                      float defaultValue)

getFloat
```
public float getFloat(String name)
```

getDouble

public double getDouble(String name,
                        double defaultValue)

getDouble
```
public double getDouble(String name)
```

getBytes
```
public byte[] getBytes(String name)
```

getString
```
public String getString(String name)
```

getString

public String getString(String name,
                        String defaultValue)

getStruct
```
public Struct getStruct(String name)
```

getTimestamp

public Timestamp getTimestamp(String name)

getUUID
```
public UUID getUUID(String name)
```

entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
Specified by:

entrySet in interface Map<String,Object>

keySet
```
public Set<String> keySet()
```
Specified by:

keySet in interface Map<String,Object>

clear
```
public void clear()
```
Specified by:

clear in interface Map<String,Object>

get
```
public Object get(Object name)
```
Specified by:

get in interface Map<String,Object>

containsKey
```
public boolean containsKey(Object name)
```
Specified by:

containsKey in interface Map<String,Object>

containsValue
```
public boolean containsValue(Object value)
```
Specified by:

containsValue in interface Map<String,Object>

Class Struct

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Map

Constructor Detail

Struct

Struct

Method Detail

size

isEmpty

names

values

iterator

append

put

remove

remove

putAll

with

withNonNull

with

without

toString

equals

has

sortedNames

get

getBoolean

getBoolean

getByte

getByte

getShort

getShort

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getBytes

getString

getString

getStruct

getTimestamp

getUUID

entrySet

keySet

clear

get

containsKey

containsValue