XML Schema API: Interface XSAnnotation

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.xerces.xs
Interface XSAnnotation

All Superinterfaces:
  XSObject

public interface XSAnnotation
extends XSObject

This interface represents the Annotation schema component.

Field Summary
`static short` | `SAX_CONTENTHANDLER` The object type is `org.xml.sax.ContentHandler`.
`static short` | `W3C_DOM_DOCUMENT` The object type is `org.w3c.dom.Document`.
`static short` | `W3C_DOM_ELEMENT` The object type is `org.w3c.dom.Element`.

Method Summary
`java.lang.String` | `getAnnotationString()` A text representation of the annotation.
`boolean` | `writeAnnotation(java.lang.Object target, short targetType)` Write contents of the annotation to the specified object.

Methods inherited from interface org.apache.xerces.xs.XSObject
`getName, getNamespace, getNamespaceItem, getType`

Field Detail

### W3C_DOM_ELEMENT

    public static final short W3C_DOM_ELEMENT

  The object type is `org.w3c.dom.Element`.

### SAX_CONTENTHANDLER

    public static final short SAX_CONTENTHANDLER

  The object type is `org.xml.sax.ContentHandler`.

### W3C_DOM_DOCUMENT

    public static final short W3C_DOM_DOCUMENT

  The object type is `org.w3c.dom.Document`.

Method Detail

### writeAnnotation

    public boolean writeAnnotation(java.lang.Object target,
                                   short targetType)

  Write contents of the annotation to the specified object. If the specified `target` is a DOM object, in-scope namespace declarations for `annotation` element are added as attribute nodes of the serialized `annotation`, otherwise the corresponding events for all in-scope namespace declarations are sent via the specified document handler.
  Parameters:
    `target` - A target pointer to the annotation target object, i.e. `org.w3c.dom.Document`, `org.w3c.dom.Element` , `org.xml.sax.ContentHandler`.
    `targetType` - A target type.
  Returns:
    True if the `target` is a recognized type and supported by this implementation, otherwise false.

### getAnnotationString

    public java.lang.String getAnnotationString()

  A text representation of the annotation.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved.