Package de.javagl.ply

Class ObjectPlySource

java.lang.Object

de.javagl.ply.ObjectPlySource

All Implemented Interfaces:

PlySource

public final class ObjectPlySource
extends Object
implements PlySource

Implementation of a PlySource that can be backed by list of objects

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectPlySource.Handle<T>	The handle that is returned from register(String, List) and that allows configuring how the objects are converted into elements.

Constructor Summary

Constructors

Constructor	Description
ObjectPlySource(Descriptor descriptor)	Creates a new instance with the given Descriptor

Method Summary

Modifier and Type	Method	Description
Descriptor	getDescriptor()	Returns the Descriptor that describes the structure of the data.
List<Element>	getElementList(int elementTypeIndex)	Returns an unmodifiable list of Element objects for the specified element type index
List<Element>	getElementList(String elementName)	Returns an unmodifiable list of Element objects for the elements with the given name, or null if there are no elements with the given name.
<T> ObjectPlySource.Handle<T>	register(String elementName, List<T> objects)	Register a new element type to be provided by this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPlySource

public ObjectPlySource(Descriptor descriptor)

Creates a new instance with the given Descriptor

Parameters:

descriptor - The Descriptor

Method Detail

getDescriptor

public Descriptor getDescriptor()

Description copied from interface: PlySource

Returns the Descriptor that describes the structure of the data.

Specified by:

getDescriptor in interface PlySource

Returns:

The Descriptor

register

public <T> ObjectPlySource.Handle<T> register(String elementName,
                                              List<T> objects)

Register a new element type to be provided by this instance. This will return a ObjectPlySource.Handle that allows further configuration about how to provide the specific element type. The handle offers methods to configure how each property is supposed to be provided, using the handle.with... functions.

Type Parameters:

T - The element type

Parameters:

elementName - The element name

objects - The objects

Returns:

The ObjectPlySource.Handle

getElementList

public List<Element> getElementList(String elementName)

Description copied from interface: PlySource

Returns an unmodifiable list of Element objects for the elements with the given name, or null if there are no elements with the given name.

Specified by:

getElementList in interface PlySource

Parameters:

elementName - The element name

Returns:

The Element list

getElementList

public List<Element> getElementList(int elementTypeIndex)

Description copied from interface: PlySource

Returns an unmodifiable list of Element objects for the specified element type index

Specified by:

getElementList in interface PlySource

Parameters:

elementTypeIndex - The element type index

Returns:

The Element list