001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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    }