CheckXMLSupport (XML Tools API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.api.xml/1 1.14

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.xml.cookies
Class CheckXMLSupport

java.lang.Object
  org.netbeans.spi.xml.cookies.CheckXMLSupport

All Implemented Interfaces:: CheckXMLCookie, Node.Cookie

public class CheckXMLSupport
extends Object
implements CheckXMLCookie
extends Object
implements CheckXMLCookie

CheckXMLCookie implementation support simplifing cookie providers based on InputSources representing XML documents and entities.

Primary use case in a DataObject subclass (which primary file is XML):

   CookieSet cookies = getCookieSet();
   InputSource in = DataObjectAdapters.inputSource(this);
   CheckXMLSupport cookieImpl = new CheckXMLSupport(in);
   cookies.add(cookieImpl);

Secondary use case: Subclasses can customize the class by customization protected methods. The customized subclass can be used according to primary use case.

Field Summary

static int CHECK_ENTITY_MODE
          General parsed entity strategy.

static int CHECK_PARAMETER_ENTITY_MODE
          Parameter parsed entity strategy.

static int DOCUMENT_MODE
          XML document entity strategy.

Constructor Summary

CheckXMLSupport(InputSource inputSource)
          Create new CheckXMLSupport for given data object using DOCUMENT_MODE strategy.

CheckXMLSupport(InputSource inputSource, int strategy)
          Create new CheckXMLSupport for given data object.

Method Summary

boolean checkXML(CookieObserver l)
          Check XML parsed entity for syntax wellformedness.

protected EntityResolver createEntityResolver()
          Parametrizes default parser creatin process.

protected InputSource createInputSource()
          Create InputSource to be checked.

protected XMLReader createParser(boolean validate)
          Create and preconfigure new parser.

Methods inherited from class java.lang.Object

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

Field Summary
`static int`	`CHECK_ENTITY_MODE` General parsed entity strategy.
`static int`	`CHECK_PARAMETER_ENTITY_MODE` Parameter parsed entity strategy.
`static int`	`DOCUMENT_MODE` XML document entity strategy.

Constructor Summary
`CheckXMLSupport(InputSource inputSource)` Create new CheckXMLSupport for given data object using DOCUMENT_MODE strategy.
`CheckXMLSupport(InputSource inputSource, int strategy)` Create new CheckXMLSupport for given data object.

Method Summary
`boolean`	`checkXML(CookieObserver l)` Check XML parsed entity for syntax wellformedness.
`protected EntityResolver`	`createEntityResolver()` Parametrizes default parser creatin process.
`protected InputSource`	`createInputSource()` Create InputSource to be checked.
`protected XMLReader`	`createParser(boolean validate)` Create and preconfigure new parser.

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

Field Detail

CHECK_ENTITY_MODE

public static final int CHECK_ENTITY_MODE

General parsed entity strategy. This strategy works well only for standalone (no entity reference) external entities.

See Also:: Constant Field Values

CHECK_PARAMETER_ENTITY_MODE

public static final int CHECK_PARAMETER_ENTITY_MODE

Parameter parsed entity strategy. This strategy is suitable for standalone (no undeclared parameter entity reference) external DTDs.

See Also:: Constant Field Values

DOCUMENT_MODE

public static final int DOCUMENT_MODE

XML document entity strategy. It is ordinary XML document processing mode.

See Also:: Constant Field Values

Constructor Detail