com.sun.xml.fastinfoset.stax.events.DTDEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of FastInfoset Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2004, 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle 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
 *
 *      https://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.xml.fastinfoset.stax.events;

import java.util.List;

import javax.xml.stream.events.DTD;
import javax.xml.stream.events.EntityDeclaration;
import javax.xml.stream.events.NotationDeclaration;

/**
 * DTDEvent. Notations and Entities are not used
 */
public class DTDEvent extends EventBase implements DTD{
    
    private String _dtd;
    private List _notations;
    private List _entities;
    
    /** Creates a new instance of DTDEvent */
    @SuppressWarnings({"this-escape"})
    public DTDEvent() {
        setEventType(DTD);
    }

    @SuppressWarnings({"this-escape"})
    public DTDEvent(String dtd){
        setEventType(DTD);
        _dtd = dtd;
    }

    /**
     * Returns the entire Document Type Declaration as a string, including the
     * internal DTD subset.This may be null if there is not an internal subset.
     * If it is not null it must return the entire Document Type Declaration
     * which matches the doctypedecl production in the XML 1.0 specification
     *
     */
    @Override
    public String getDocumentTypeDeclaration() {
        return _dtd;
    }

    public void setDTD(String dtd) {
        _dtd = dtd;
    }

    /**
     * Return a List containing the general entities, both external and
     * internal, declared in the DTD. This list must contain EntityDeclaration
     * events.
     *
     * @see EntityDeclaration
     * @return an unordered list of EntityDeclaration events
     */
    @Override
    public List getEntities() {
        return _entities;
    }

    /**
     * Return a List containing the notations declared in the DTD. This list
     * must contain NotationDeclaration events.
     *
     * @see NotationDeclaration
     * @return an unordered list of NotationDeclaration events
     */
    @Override
    public List getNotations() {
        return _notations;
    }

    /**
     * Returns an implementation defined representation of the DTD.This method
     * may return null if no representation is available.
     *
     */
    @Override
    public Object getProcessedDTD() {
        return null;
    }

    public void setEntities(List entites) {
        _entities = entites;
    }

    public void setNotations(List notations) {
        _notations = notations;
    }

    @Override
    public String toString() {
        return _dtd;
    }
}