com.phloc.commons.microdom.IMicroDocument Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed 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.phloc.commons.microdom;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Represents a complete document.
*
* @author Philip Helger
*/
public interface IMicroDocument extends IMicroNodeWithChildren
{
/**
* @return true if the document is standalone, false
* if not. The default value is false.
*/
boolean isStandalone ();
/**
* Change the standalone state of this document.
*
* @param bIsStandalone
* The new value. true for standalone, false
* if not.
*/
void setStandalone (final boolean bIsStandalone);
/**
* @return May be null.
*/
@Nullable
IMicroDocumentType getDocType ();
/**
* @return May be null.
*/
@Nullable
IMicroElement getDocumentElement ();
/**
* {@inheritDoc}
*/
@Nonnull
IMicroDocument getClone ();
}