pl.mbdev.openstage
Class XmlWithKey

java.lang.Object
  extended by pl.mbdev.openstage.Xml
      extended by pl.mbdev.openstage.XmlWithKey
Direct Known Subclasses:
IppPlayer

public abstract class XmlWithKey
extends Xml

A superclass of various objects that have a key attribute.

 Copyright 2011 Mateusz Bysiek,
     mb@mbdev.pl, http://mbdev.pl/
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 

Author:
Mateusz Bysiek

Field Summary
private  java.lang.String key
          Name of the key, from key-value pair of various objects.
 
Constructor Summary
XmlWithKey(java.lang.String nodeName, java.lang.String key)
          Creates new XML object with key.
XmlWithKey(java.lang.String nodeName, java.lang.String key, java.lang.Object contents)
          Creates new XML object with key.
 
Method Summary
protected  java.lang.StringBuffer firstAttributesToXmlString()
          Special method used by intermediate subclasses, which may desire to attach attributes to the object without need to override attirbutesToXmlString() method.
 
Methods inherited from class pl.mbdev.openstage.Xml
add, add, addAndReturn, attributesToXmlString, attributeToXml, getContents, getLogicalRoot, getParent, getSubNode, getSubNodeIndex, getSubNodes, getXmlHeader, isEmpty, logicalAdd, sendTo, setContents, setParent, subObjectsCount, subObjectsToXmlString, toXmlString, wrapWithIppItem
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

key

private final java.lang.String key
Name of the key, from key-value pair of various objects.

Constructor Detail

XmlWithKey

public XmlWithKey(java.lang.String nodeName,
                  java.lang.String key)
Creates new XML object with key.

Parameters:
nodeName - name of the XML node
key - name of the key, from key-value pair of various objects

XmlWithKey

public XmlWithKey(java.lang.String nodeName,
                  java.lang.String key,
                  java.lang.Object contents)
Creates new XML object with key.

Parameters:
nodeName - name of the XML node
key - name of the key, from key-value pair of various objects
contents - contents of this node
Method Detail

firstAttributesToXmlString

protected java.lang.StringBuffer firstAttributesToXmlString()
Description copied from class: Xml
Special method used by intermediate subclasses, which may desire to attach attributes to the object without need to override attirbutesToXmlString() method.

Overrides:
firstAttributesToXmlString in class Xml
Returns:
should return attributes of the intermediate subclass in a XML-text format