generated.docs.javadoc.org.eclipse.dawnsci.nexus.builder.impl.MapBasedMetadataProvider.html Maven / Gradle / Ivy






MapBasedMetadataProvider (h5jan API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus.builder.impl
Class MapBasedMetadataProvider



java.lang.Object


org.eclipse.dawnsci.nexus.builder.impl.MapBasedMetadataProvider







All Implemented Interfaces:
NexusEntryModification, NexusMetadataProvider




public class MapBasedMetadataProvider
extends java.lang.Object
implements NexusMetadataProvider
A implementation of NexusMetadataProvider that uses an internal Map.
 The methods addMetadataEntry(String, Object) and setCategory(NexusBaseClass)
 return this object, so that they can be chained.











Nested Class Summary




Nested classes/interfaces inherited from interface org.eclipse.dawnsci.nexus.builder.NexusMetadataProvider
NexusMetadataProvider.MetadataEntry








Constructor Summary

Constructors 

Constructor and Description


MapBasedMetadataProvider()
Create a new MapBasedMetadataProvider



MapBasedMetadataProvider(java.util.Map<java.lang.String,?> map)
Create a new MapBasedMetadataProvider.



MapBasedMetadataProvider(NexusBaseClass category)
Create a new MapBasedMetadataProvider










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


MapBasedMetadataProvider
addMetadataEntry(java.lang.String name,
                java.lang.Object value)
Adds a metadata entry with the given name and value



NexusBaseClass
getCategory()
Returns the category of this metadata provider.



java.util.Iterator<NexusMetadataProvider.MetadataEntry>
getMetadataEntries()
Returns an iterator over the metadata entries.



MapBasedMetadataProvider
setCategory(NexusBaseClass category)
Sets the category of this metadata provider.







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














Constructor Detail





MapBasedMetadataProvider
public MapBasedMetadataProvider()
Create a new MapBasedMetadataProvider







MapBasedMetadataProvider
public MapBasedMetadataProvider(NexusBaseClass category)
Create a new MapBasedMetadataProvider







MapBasedMetadataProvider
public MapBasedMetadataProvider(java.util.Map<java.lang.String,?> map)
Create a new MapBasedMetadataProvider.

Parameters:
map - map










Method Detail





addMetadataEntry
public MapBasedMetadataProvider addMetadataEntry(java.lang.String name,
                                                 java.lang.Object value)
Adds a metadata entry with the given name and value

Parameters:
name - name
value - value
Returns:
this object, for convenience








setCategory
public MapBasedMetadataProvider setCategory(NexusBaseClass category)
Sets the category of this metadata provider. This metadata entries will
 be added as fields to the group of this type within the nexus tree.

Parameters:
category - category, an enumeration value from NexusBaseClass.
Returns:
this object, for convenience








getCategory
public NexusBaseClass getCategory()
Description copied from interface: NexusMetadataProvider
Returns the category of this metadata provider. If this method does not
 return null, then fields will be added to the
 nexus object (i.e. group node) in the tree with this type instead
 of the NXentry for each root node.

Specified by:
getCategory in interface NexusMetadataProvider
Returns:
category category, a member of the NexusBaseClass
   enumeration of Nexus base class types.








getMetadataEntries
public java.util.Iterator<NexusMetadataProvider.MetadataEntry> getMetadataEntries()
Description copied from interface: NexusMetadataProvider
Returns an iterator over the metadata entries.

Specified by:
getMetadataEntries in interface NexusMetadataProvider
Returns:
iterator over metadata entries














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`MapBasedMetadataProvider`	`addMetadataEntry(java.lang.String name, java.lang.Object value)` Adds a metadata entry with the given name and value
`NexusBaseClass`	`getCategory()` Returns the category of this metadata provider.
`java.util.Iterator<NexusMetadataProvider.MetadataEntry>`	`getMetadataEntries()` Returns an iterator over the metadata entries.
`MapBasedMetadataProvider`	`setCategory(NexusBaseClass category)` Sets the category of this metadata provider.