Package ucar.array

Class StructureMembers

java.lang.Object

ucar.array.StructureMembers

All Implemented Interfaces:

Iterable<StructureMembers.Member>

@Immutable
public final class StructureMembers
extends Object
implements Iterable<StructureMembers.Member>

A collection of members contained in StructureData. Nested Structures may be stored on or off the heap.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StructureMembers.Builder
static class	StructureMembers.Member	A member of a StructureData.
static class	StructureMembers.MemberBuilder

Method Summary

Modifier and Type	Method	Description
static StructureMembers.Builder	builder()	Create an StructureMembers builder.
boolean	contains(StructureMembers.Member want)	Check that a member exists
boolean	containsNested(StructureMembers.Member want)	Test a nested member exists, arbitrary depth.
boolean	equals(Object o)
StructureMembers.Member	findMember(String memberName)	Find the member by its name.
StructureMembers.Member	getMember(int index)	Get the index-th member
List<String>	getMemberNames()	Get the names of the members.
List<StructureMembers.Member>	getMembers()	Get the list of Member objects.
String	getName()	Get the StructureMembers' name.
int	getStorageSizeBytes()	Get the total size of one Structure in bytes.
int	hashCode()
Iterator<StructureMembers.Member>	iterator()	Iterate over the Members.
static StructureMembers.MemberBuilder	memberBuilder()	Create an StructureMembers builder.
int	numberOfMembers()	Get the number of members
boolean	structuresOnHeap()
StructureMembers.Builder	toBuilder()	Turn into a mutable Builder.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getName

@Nullable
public String getName()

Get the StructureMembers' name.

numberOfMembers

public int numberOfMembers()

Get the number of members

getMembers

public List<StructureMembers.Member> getMembers()

Get the list of Member objects.

getMemberNames

public List<String> getMemberNames()

Get the names of the members.

getMember

public StructureMembers.Member getMember(int index)

Get the index-th member

findMember

@Nullable
public StructureMembers.Member findMember(String memberName)

Find the member by its name.

contains

public boolean contains(StructureMembers.Member want)

Check that a member exists

containsNested

public boolean containsNested(StructureMembers.Member want)

Test a nested member exists, arbitrary depth.

getStorageSizeBytes

public int getStorageSizeBytes()

Get the total size of one Structure in bytes.

structuresOnHeap

public boolean structuresOnHeap()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

public Iterator<StructureMembers.Member> iterator()

Iterate over the Members.

Specified by:

iterator in interface Iterable<StructureMembers.Member>

toBuilder

public StructureMembers.Builder toBuilder()

Turn into a mutable Builder. Can use toBuilder().build(wantsData) to copy.

builder

public static StructureMembers.Builder builder()

Create an StructureMembers builder.

memberBuilder

public static StructureMembers.MemberBuilder memberBuilder()

Create an StructureMembers builder.