AbstractMetadataNode

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.device.AbstractMetadataNode

All Implemented Interfaces:: INameable, MetadataNode

Direct Known Subclasses:: AbstractMetadataField, GroupMetadataNode, LinkedField

public abstract class AbstractMetadataNode extends AbstractNameable implements MetadataNode

A node that can be part of a metadata device.

Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AbstractMetadataNode()

protected

AbstractMetadataNode(String nodeName)
Method Summary

Modifier and Type

Method

Description

void

addAttribute(MetadataAttribute attr)

void

addAttributes(List<MetadataAttribute> attributes)

void

clearAttributes()

protected void

createAttributes(Node node)

final Node

createNode()

Create and return the nexus Node for this object.

protected abstract Node

doCreateNode()

protected Node

handleError(NexusException e)

boolean

hasAttributes()

void

removeAttribute(String attrName)

void

setAttributes(List<MetadataAttribute> attributes)

Methods inherited from class org.eclipse.scanning.api.AbstractNameable
equals, getName, hashCode, setName, toString

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

Methods inherited from interface org.eclipse.scanning.api.INameable
getName, setName

Methods inherited from interface org.eclipse.scanning.device.MetadataNode
isDefaultValue

Constructor Details
- AbstractMetadataNode
  
  protected AbstractMetadataNode()
- AbstractMetadataNode
  
  protected AbstractMetadataNode(String nodeName)
Method Details
- createNode
  
  public final Node createNode() throws NexusException
  
  Description copied from interface: MetadataNode
  
  Create and return the nexus Node for this object.
  
  Specified by:
  
  createNode in interface MetadataNode
  
  Throws:
  
  NexusException - if the node could not be created for any reason
- handleError
  
  protected Node handleError(NexusException e) throws NexusException
  
  Throws:
  
  NexusException
- doCreateNode
  
  protected abstract Node doCreateNode() throws NexusException
  
  Throws:
  
  NexusException
- createAttributes
  
  protected void createAttributes(Node node) throws NexusException
  
  Throws:
  
  NexusException
- addAttribute
  
  public void addAttribute(MetadataAttribute attr)
- addAttributes
  
  public void addAttributes(List<MetadataAttribute> attributes)
- removeAttribute
  
  public void removeAttribute(String attrName)
- clearAttributes
  
  public void clearAttributes()
- setAttributes
  
  public void setAttributes(List<MetadataAttribute> attributes)
- hasAttributes
  
  public boolean hasAttributes()