com.rultor.snapshot

Class Snapshot

java.lang.Object

com.rultor.snapshot.Snapshot

@Immutable
public final class Snapshot
extends Object

Snapshot.

Since:

1.0

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Suppressed Checkstyle violations:

ClassDataAbstractionCoupling (500 lines)

Constructor Summary

Constructors

Constructor and Description
Snapshot(org.xembly.Directives dirs) Public ctor.
Snapshot(InputStream stream) Public ctor.
Snapshot(String script) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(Document dom) Apply it to the DOM.
Document	dom() Make DOM out of it.
static Document	empty() Get empty DOM.
String	xembly() Get xembly script.
XmlDocument	xml() Make XML out of it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Snapshot

public Snapshot(InputStream stream)
         throws IOException,
                org.xembly.XemblySyntaxException

Public ctor.

Parameters:

stream - Stream to read it from

Throws:

IOException - If fails to read

org.xembly.XemblySyntaxException - If some syntax exception inside

Suppressed Checkstyle violations:

ThrowsCount (5 lines), RedundantThrows (5 lines)

Snapshot

public Snapshot(String script)
         throws org.xembly.XemblySyntaxException

Public ctor.

Parameters:

script - Script

Throws:

org.xembly.XemblySyntaxException - If can't parse

Suppressed Checkstyle violations:

RedundantThrows (5 lines)

Snapshot

public Snapshot(org.xembly.Directives dirs)

Public ctor.

Parameters:

dirs - Directives

Method Detail

xembly

public String xembly()

Get xembly script.

Returns:

The script

empty

public static Document empty()

Get empty DOM.

Returns:

The DOM

dom

public Document dom()
             throws org.xembly.ImpossibleModificationException

Make DOM out of it.

Returns:

The DOM

Throws:

org.xembly.ImpossibleModificationException - If can't apply

Suppressed Checkstyle violations:

RedundantThrows (3 lines)

xml

public XmlDocument xml()
                throws org.xembly.ImpossibleModificationException

Make XML out of it.

Returns:

The XML

Throws:

org.xembly.ImpossibleModificationException - If can't apply

Suppressed Checkstyle violations:

RedundantThrows (3 lines)

apply

@Loggable(value=1,
          ignore=org.xembly.ImpossibleModificationException.class)
public void apply(Document dom)
           throws org.xembly.ImpossibleModificationException

Apply it to the DOM.

Parameters:

dom - DOM document

Throws:

org.xembly.ImpossibleModificationException - If fails at some point

Suppressed Checkstyle violations:

RedundantThrows (10 lines)