001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.xml;
016    
017    import java.io.IOException;
018    
019    /**
020     * @author Brian Wing Shun Chan
021     */
022    public interface Document extends Branch {
023    
024            public Document addComment(String comment);
025    
026            public Document addDocumentType(
027                    String name, String publicId, String systemId);
028    
029            public String formattedString() throws IOException;
030    
031            public String formattedString(String indent) throws IOException;
032    
033            public String formattedString(String indent, boolean expandEmptyElements)
034                    throws IOException;
035    
036            public String formattedString(
037                            String indent, boolean expandEmptyElements, boolean trimText)
038                    throws IOException;
039    
040            public DocumentType getDocumentType();
041    
042            public Element getRootElement();
043    
044            public String getXMLEncoding();
045    
046            public void setRootElement(Element rootElement);
047    
048            public void setXMLEncoding(String encoding);
049    
050    }