001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.spi.xml.cookies;
042:
043: import org.xml.sax.InputSource;
044:
045: import org.netbeans.api.xml.cookies.*;
046:
047: /**
048: * <code>CheckXMLCookie</code> implementation support simplifing cookie providers
049: * based on <code>InputSource</code>s representing XML documents and entities.
050: * <p>
051: * <b>Primary use case</b> in a DataObject subclass (which primary file is XML):
052: * <pre>
053: * CookieSet cookies = getCookieSet();
054: * InputSource in = DataObjectAdapters.inputSource(this);
055: * CheckXMLSupport cookieImpl = new CheckXMLSupport(in);
056: * cookies.add(cookieImpl);
057: * </pre>
058: * <p>
059: * <b>Secondary use case:</b> Subclasses can customize the class by customization
060: * protected methods. The customized subclass can be used according to
061: * primary use case.
062: *
063: * @author Petr Kuzel
064: */
065: public class CheckXMLSupport extends SharedXMLSupport implements
066: CheckXMLCookie {
067:
068: /**
069: * General parsed entity strategy. This strategy works well only for
070: * standalone (no entity reference) external entities.
071: */
072: public static final int CHECK_ENTITY_MODE = 1;
073:
074: /**
075: * Parameter parsed entity strategy. This strategy is suitable for standalone
076: * (no undeclared parameter entity reference) external DTDs.
077: */
078: public static final int CHECK_PARAMETER_ENTITY_MODE = 2;
079:
080: /**
081: * XML document entity strategy. It is ordinary XML document processing mode.
082: */
083: public static final int DOCUMENT_MODE = 3;
084:
085: /**
086: * Create new CheckXMLSupport for given data object using DOCUMENT_MODE strategy.
087: * @param inputSource Supported data object.
088: */
089: public CheckXMLSupport(InputSource inputSource) {
090: super (inputSource);
091: }
092:
093: /**
094: * Create new CheckXMLSupport for given data object.
095: * @param inputSource Supported data object.
096: * @param strategy One of <code>*_MODE</code> constants.
097: */
098: public CheckXMLSupport(InputSource inputSource, int strategy) {
099: super (inputSource, strategy);
100: }
101:
102: // inherit JavaDoc
103: public boolean checkXML(CookieObserver l) {
104: return super.checkXML(l);
105: }
106: }
|