com.sun.org.apache.xerces.internal.dom.ProcessingInstructionImpl Maven / Gradle / Ivy
Show all versions of jaxp-ri Show documentation
/*
* 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.dom;
import org.w3c.dom.Node;
import org.w3c.dom.ProcessingInstruction;
/**
* Processing Instructions (PIs) permit documents to carry
* processor-specific information alongside their actual content. PIs
* are most common in XML, but they are supported in HTML as well.
*
* This class inherits from CharacterDataImpl to reuse its setNodeValue method.
*
* @xerces.internal
*
* @version $Id: ProcessingInstructionImpl.java,v 1.6 2010-11-01 04:39:39 joehw Exp $
* @since PR-DOM-Level-1-19980818.
*/
public class ProcessingInstructionImpl
extends CharacterDataImpl
implements ProcessingInstruction {
//
// Constants
//
/** Serialization version. */
static final long serialVersionUID = 7554435174099981510L;
//
// Data
//
protected String target;
//
// Constructors
//
/** Factory constructor. */
public ProcessingInstructionImpl(CoreDocumentImpl ownerDoc,
String target, String data) {
super(ownerDoc, data);
this.target = target;
}
//
// Node methods
//
/**
* A short integer indicating what type of node this is. The named
* constants for this value are defined in the org.w3c.dom.Node interface.
*/
public short getNodeType() {
return Node.PROCESSING_INSTRUCTION_NODE;
}
/**
* Returns the target
*/
public String getNodeName() {
if (needsSyncData()) {
synchronizeData();
}
return target;
}
//
// ProcessingInstruction methods
//
/**
* A PI's "target" states what processor channel the PI's data
* should be directed to. It is defined differently in HTML and XML.
*
* In XML, a PI's "target" is the first (whitespace-delimited) token
* following the "
* In HTML, target is always null.
*
* Note that getNodeName is aliased to getTarget.
*/
public String getTarget() {
if (needsSyncData()) {
synchronizeData();
}
return target;
} // getTarget():String
/**
* A PI's data content tells the processor what we actually want it
* to do. It is defined slightly differently in HTML and XML.
*
* In XML, the data begins with the non-whitespace character
* immediately after the target -- @see getTarget().
*
* In HTML, the data begins with the character immediately after the
* "<?" token that begins the PI.
*
* Note that getNodeValue is aliased to getData
*/
public String getData() {
if (needsSyncData()) {
synchronizeData();
}
return data;
} // getData():String
/**
* Change the data content of this PI.
* Note that setData is aliased to setNodeValue.
* @see #getData().
* @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is read-only.
*/
public void setData(String data) {
// Hand off to setNodeValue for code-reuse reasons (mutation
// events, readonly protection, synchronizing, etc.)
setNodeValue(data);
} // setData(String)
/**
* Returns the absolute base URI of this node or null if the implementation
* wasn't able to obtain an absolute URI. Note: If the URI is malformed, a
* null is returned.
*
* @return The absolute base URI of this node or null.
* @since DOM Level 3
*/
public String getBaseURI() {
if (needsSyncData()) {
synchronizeData();
}
return ownerNode.getBaseURI();
}
} // class ProcessingInstructionImpl