1/* 2 * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package javax.xml.stream.events; 27 28import java.util.List; 29 30/** 31 * This is the top level interface for events dealing with DTDs 32 * 33 * @version 1.0 34 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved. 35 * @since 1.6 36 */ 37public interface DTD extends XMLEvent { 38 39 /** 40 * Returns the entire Document Type Declaration as a string, including the 41 * internal DTD subset. This may be null if there is not an internal subset. 42 * If it is not null it must return the entire Document Type Declaration 43 * which matches the doctypedecl production in the XML 1.0 specification 44 * 45 * @return the Document Type Declaration 46 */ 47 String getDocumentTypeDeclaration(); 48 49 /** 50 * Returns an implementation defined representation of the DTD. This method 51 * may return null if no representation is available. 52 * 53 * @return the representation of the DTD 54 */ 55 Object getProcessedDTD(); 56 57 /** 58 * Return a List containing the notations declared in the DTD. This list 59 * must contain NotationDeclaration events. 60 * 61 * @see NotationDeclaration 62 * @return an unordered list of NotationDeclaration events 63 */ 64 List<NotationDeclaration> getNotations(); 65 66 /** 67 * Return a List containing the general entities, both external and 68 * internal, declared in the DTD. This list must contain EntityDeclaration 69 * events. 70 * 71 * @see EntityDeclaration 72 * @return an unordered list of EntityDeclaration events 73 */ 74 List<EntityDeclaration> getEntities(); 75} 76