com.sun.org.apache.xerces.internal.xpointer.XPointerPart Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.jaxp-ri
Show all versions of org.apache.servicemix.bundles.jaxp-ri
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package com.sun.org.apache.xerces.internal.xpointer;
import com.sun.org.apache.xerces.internal.xni.Augmentations;
import com.sun.org.apache.xerces.internal.xni.QName;
import com.sun.org.apache.xerces.internal.xni.XMLAttributes;
import com.sun.org.apache.xerces.internal.xni.XNIException;
/**
*
* Used for scheme specific parsing and evaluation of an XPointer expression.
* This interface applies to both ShortHand and SchemeBased XPointer
* expressions.
*
*
* @xerces.internal
*
* @version $Id: XPointerPart.java,v 1.5 2010-11-01 04:40:26 joehw Exp $
*/
public interface XPointerPart {
// The start element event
public static final int EVENT_ELEMENT_START = 0;
// The end element event
public static final int EVENT_ELEMENT_END = 1;
// The empty element event
public static final int EVENT_ELEMENT_EMPTY = 2;
/**
* Provides scheme specific parsing of a XPointer expression i.e.
* the PointerPart or ShortHandPointer.
*
* @param xpointer A String representing the PointerPart or ShortHandPointer.
* @throws XNIException Thrown if the PointerPart string does not conform to
* the syntax defined by its scheme.
*
*/
public void parseXPointer(String part) throws XNIException;
/**
* Evaluates an XML resource with respect to an XPointer expressions
* by checking if it's element and attributes parameters match the
* criteria specified in the xpointer expression.
*
* @param element - The name of the element.
* @param attributes - The element attributes.
* @param augs - Additional information that may include infoset augmentations
* @param event - An integer indicating
* 0 - The start of an element
* 1 - The end of an element
* 2 - An empty element call
* @throws XNIException Thrown to signal an error
*
*/
public boolean resolveXPointer(QName element, XMLAttributes attributes,
Augmentations augs, int event) throws XNIException;
/**
* Returns true if the XPointer expression resolves to a resource fragment
* specified as input else returns false.
*
* @return True if the xpointer expression matches a fragment in the resource
* else returns false.
* @throws XNIException Thrown to signal an error
*
*/
public boolean isFragmentResolved() throws XNIException;
/**
* Returns true if the XPointer expression resolves to a non-element child
* of the current resource fragment.
*
* @return True if the XPointer expression resolves to a non-element child
* of the current resource fragment.
* @throws XNIException Thrown to signal an error
*
*/
public boolean isChildFragmentResolved() throws XNIException;
/**
* Returns a String containing the scheme name of the PointerPart
* or the name of the ShortHand Pointer.
*
* @return A String containing the scheme name of the PointerPart.
*
*/
public String getSchemeName();
/**
* Returns a String containing the scheme data of the PointerPart.
*
* @return A String containing the scheme data of the PointerPart.
*
*/
public String getSchemeData();
/**
* Sets the scheme name of the PointerPart or the ShortHand Pointer name.
*
* @param schemeName A String containing the scheme name of the PointerPart.
*
*/
public void setSchemeName(String schemeName);
/**
* Sets the scheme data of the PointerPart.
*
* @param schemeData A String containing the scheme data of the PointerPart.
*
*/
public void setSchemeData(String schemeData);
}