org.openjdk.jmc.common.unit

Class StructContentType<T>

java.lang.Object

org.openjdk.jmc.common.unit.ContentType<T>

org.openjdk.jmc.common.unit.StructContentType<T>

All Implemented Interfaces:

IDescribable, IType<T>

Direct Known Subclasses:

RangeContentType

public class StructContentType<T>
extends ContentType<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StructContentType.AccessorEntry<T>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description
private java.util.Map<IAccessorKey<?>,StructContentType.AccessorEntry<T>>	m_accessors
private java.util.List<IAttribute<?>>	m_attributes

Fields inherited from class org.openjdk.jmc.common.unit.ContentType

m_identifier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructContentType(java.lang.String identifier, java.lang.String name)
	StructContentType(java.lang.String identifier, java.lang.String name, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
<M> void	addExtraAttribute(int atIndex, IAttribute<M> attribute) Deprecated.
<M> void	addField(java.lang.String identifier, ContentType<M> contentType, java.lang.String name, java.lang.String desc, IMemberAccessor<M,T> accessor)
<M> IMemberAccessor<M,T>	getAccessor(IAccessorKey<M> attribute) Internal low-level mechanism for retrieving a member accessor for a type, or null if not available.
java.util.Map<IAccessorKey<?>,? extends IDescribable>	getAccessorKeys() Get keys for the accessors that this type knows of.
java.util.List<IAttribute<?>>	getAttributes()
java.lang.String	getDescription()

Methods inherited from class org.openjdk.jmc.common.unit.ContentType

addFormatter, getDefaultFormatter, getFormatter, getFormatters, getIdentifier, getName, getPersister, hasAttribute, lookupNameFor, toString

Methods inherited from class java.lang.Object

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

Field Detail

m_attributes

private final java.util.List<IAttribute<?>> m_attributes

m_accessors

private final java.util.Map<IAccessorKey<?>,StructContentType.AccessorEntry<T>> m_accessors

description

private final java.lang.String description

Constructor Detail

StructContentType

public StructContentType(java.lang.String identifier,
                         java.lang.String name,
                         java.lang.String description)

StructContentType

protected StructContentType(java.lang.String identifier,
                            java.lang.String name)

Method Detail

addField

public <M> void addField(java.lang.String identifier,
                         ContentType<M> contentType,
                         java.lang.String name,
                         java.lang.String desc,
                         IMemberAccessor<M,T> accessor)

addExtraAttribute

@Deprecated
public <M> void addExtraAttribute(int atIndex,
                                              IAttribute<M> attribute)

Deprecated.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IDescribable

Overrides:

getDescription in class ContentType<T>

Returns:

the description of this object

getAttributes

public java.util.List<IAttribute<?>> getAttributes()

Specified by:

getAttributes in interface IType<T>

Overrides:

getAttributes in class ContentType<T>

getAccessorKeys

public java.util.Map<IAccessorKey<?>,? extends IDescribable> getAccessorKeys()

Description copied from interface: IType

Get keys for the accessors that this type knows of. Note that the returned accessors does not necessarily cover all possible data from the items of this type, and that it is always possible to define additional accessors that get or calculate values from the items in non-standard ways.

Should only be used for low level type inspection. Iterators etc. should use a collection of predefined attributes.

Specified by:

getAccessorKeys in interface IType<T>

Overrides:

getAccessorKeys in class ContentType<T>

Returns:

keys for the accessors defined for this type

getAccessor

public <M> IMemberAccessor<M,T> getAccessor(IAccessorKey<M> attribute)

Description copied from interface: IType

Internal low-level mechanism for retrieving a member accessor for a type, or null if not available.

This is only intended to be used by implementors of IAccessorFactory. All other usage should be replaced with ICanonicalAccessorFactory.getAccessor(IType) call to pre-defined accessors.

Specified by:

getAccessor in interface IType<T>

Overrides:

getAccessor in class ContentType<T>

Type Parameters:

M - accessor value type

Parameters:

attribute - the identifier for the field

Returns:

a member accessor