ucar.ma2

Class StructureMembers

java.lang.Object

ucar.ma2.StructureMembers

public final class StructureMembers
extends Object

A Collection of members contained in a StructureData. TODO make immutable

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
StructureMembers(String name) Deprecated. use Builder
StructureMembers(StructureMembers from) Deprecated. use toBuilder().build(false) to make a copy with no data

Method Summary

Modifier and Type	Method and Description
void	addMember(int pos, StructureMembers.Member m) Deprecated. use Builder
StructureMembers.Member	addMember(String name, String desc, String units, DataType dtype, int[] shape) Deprecated. use Builder
void	addMember(StructureMembers.Member m) Deprecated. use Builder
static StructureMembers.Builder	builder() Create an StructureMembers builder.
StructureMembers.Member	findMember(String memberName) Find the member by its name.
StructureMembers.Member	getMember(int index) Get the index-th member
com.google.common.collect.ImmutableList<String>	getMemberNames() Get the names of the members.
com.google.common.collect.ImmutableList<StructureMembers.Member>	getMembers() Get the list of Member objects.
String	getName() Get the StructureMembers' name.
int	getStructureSize() Get the total size of the Structure in bytes.
int	hideMember(StructureMembers.Member m) Deprecated. use Builder
void	setStructureSize(int structureSize) Deprecated. use Builder
StructureMembers.Builder	toBuilder(boolean wantsData) Turn into a mutable Builder.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureMembers

@Deprecated
public StructureMembers(String name)

Deprecated. use Builder

StructureMembers

@Deprecated
public StructureMembers(StructureMembers from)

Deprecated. use toBuilder().build(false) to make a copy with no data

Method Detail

getName

public String getName()

Get the StructureMembers' name.

addMember

@Deprecated
public void addMember(StructureMembers.Member m)

Deprecated. use Builder

Add a member.

addMember

@Deprecated
public void addMember(int pos,
                                   StructureMembers.Member m)

Deprecated. use Builder

Add a member at the given position.

addMember

@Deprecated
public StructureMembers.Member addMember(String name,
                                                      String desc,
                                                      String units,
                                                      DataType dtype,
                                                      int[] shape)

Deprecated. use Builder

hideMember

@Deprecated
public int hideMember(StructureMembers.Member m)

Deprecated. use Builder

Remove the given member

Parameters:

m - member

Returns:

position that it used to occupy, or -1 if not found

getStructureSize

public int getStructureSize()

Get the total size of the Structure in bytes.

Returns:

the total size of the Structure in bytes.

setStructureSize

@Deprecated
public void setStructureSize(int structureSize)

Deprecated. use Builder

Set the total size of the Structure in bytes.

getMembers

public com.google.common.collect.ImmutableList<StructureMembers.Member> getMembers()

Get the list of Member objects.

getMemberNames

public com.google.common.collect.ImmutableList<String> getMemberNames()

Get the names of the members.

getMember

public StructureMembers.Member getMember(int index)

Get the index-th member

Parameters:

index - of member

Returns:

Member

findMember

@Nullable
public StructureMembers.Member findMember(String memberName)

Find the member by its name.

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public StructureMembers.Builder toBuilder(boolean wantsData)

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

builder

public static StructureMembers.Builder builder()

Create an StructureMembers builder.