com.jcabi.xml

Class XSLDocument

java.lang.Object

com.jcabi.xml.XSLDocument

All Implemented Interfaces:

XSL

@Immutable
public final class XSLDocument
extends Object
implements XSL

Implementation of XSL.

Objects of this class are immutable and thread-safe.

Since:

0.4

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Field Summary

Fields

Modifier and Type	Field and Description
static XSL	STRIP Strips spaces of whitespace-only text nodes.

Constructor Summary

Constructors

Constructor and Description
XSLDocument(InputStream stream) Public ctor, from XSL as an input stream.
XSLDocument(String src) Public ctor, from XSL as a string.
XSLDocument(String src, Sources srcs) Public ctor, from XSL as a string.
XSLDocument(String src, Sources srcs, Map<String,String> map) Public ctor, from XSL as a string.
XSLDocument(URI uri) Public ctor, from URI.
XSLDocument(URL url) Public ctor, from URL.
XSLDocument(XML src) Public ctor, from XML as a source.

Method Summary

Methods

Modifier and Type	Method and Description
String	applyTo(XML xml) Transform XML into text.
static XSL	make(InputStream stream) Make an instance of XSL stylesheet without I/O exceptions.
static XSL	make(URL url) Make an instance of XSL stylesheet without I/O exceptions.
String	toString()
XML	transform(XML xml) Transform XML to another one.
XSL	with(Sources src) With this sources.
XSL	with(String name, String value) With this parameter.

Methods inherited from class java.lang.Object

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

Field Detail

STRIP

public static final XSL STRIP

Strips spaces of whitespace-only text nodes.

This will NOT remove existing indentation between Element nodes currently introduced by the constructor of XMLDocument. For example:

 <a>
           <b> TXT </b>
    </a>
 

becomes

 <a>
     <b> TXT </b>
 </a>
 

Since:

0.14

Constructor Detail

XSLDocument

public XSLDocument(@NotNull(message="XML can\'t be NULL")
           XML src)

Public ctor, from XML as a source.

Parameters:

src - XSL document body

XSLDocument

public XSLDocument(@NotNull(message="URL can\'t be NULL")
           URL url)
            throws IOException

Public ctor, from URL.

Parameters:

url - Location of document

Throws:

IOException - If fails to read

Since:

0.7.4

XSLDocument

public XSLDocument(@NotNull(message="URI can\'t be NULL")
           URI uri)
            throws IOException

Public ctor, from URI.

Parameters:

uri - Location of document

Throws:

IOException - If fails to read

Since:

0.15

XSLDocument

public XSLDocument(@NotNull(message="XSL input stream can\'t be NULL")
           InputStream stream)

Public ctor, from XSL as an input stream.

Parameters:

stream - XSL input stream

XSLDocument

public XSLDocument(String src)

Public ctor, from XSL as a string.

Parameters:

src - XML document body

XSLDocument

public XSLDocument(String src,
           Sources srcs)

Public ctor, from XSL as a string.

Parameters:

src - XML document body

srcs - Sources

Since:

0.9

XSLDocument

public XSLDocument(@NotNull(message="XSL can\'t be NULL")
           String src,
           @NotNull(message="sources can\'t be NULL")
           Sources srcs,
           @NotNull(message="map of params can\'t be NULL")
           Map<String,String> map)

Public ctor, from XSL as a string.

Parameters:

src - XML document body

srcs - Sources

map - Map of XSL params

Since:

0.16

Method Detail

with

public XSL with(@NotNull(message="sources can\'t be NULL")
       Sources src)

Description copied from interface: XSL

With this sources.

Specified by:

with in interface XSL

Parameters:

src - Sources

Returns:

New XSL document

with

public XSL with(@NotNull(message="name can\'t be NULL")
       String name,
       @NotNull(message="value can\'t be NULL")
       String value)

Description copied from interface: XSL

With this parameter.

Specified by:

with in interface XSL

Parameters:

name - Name of XSL parameter

value - Value of XSL parameter

Returns:

New XSL document

make

public static XSL make(@NotNull(message="XSL input stream can\'t be NULL")
       InputStream stream)

Make an instance of XSL stylesheet without I/O exceptions.

This factory method is useful when you need to create an instance of XSL stylesheet as a static final variable. In this case you can't catch an exception but this method can help, for example:

 class Foo {
   private static final XSL STYLESHEET = XSLDocument.make(
     Foo.class.getResourceAsStream("my-stylesheet.xsl")
   );
 }

Parameters:

stream - Input stream

Returns:

XSL stylesheet

make

public static XSL make(@NotNull(message="URL can\'t be NULL")
       URL url)

Make an instance of XSL stylesheet without I/O exceptions.

Parameters:

url - URL with content

Returns:

XSL stylesheet

Since:

0.7.4

See Also:

make(InputStream)

toString

public String toString()

Overrides:

toString in class Object

transform

@NotNull(message="XML is never NULL")
public XML transform(@NotNull(message="XML can\'t be NULL")
                    XML xml)

Description copied from interface: XSL

Transform XML to another one.

Specified by:

transform in interface XSL

Parameters:

xml - Source XML document

Returns:

Result document

applyTo

public String applyTo(@NotNull(message="XML can\'t be NULL")
             XML xml)

Description copied from interface: XSL

Transform XML into text.

Specified by:

applyTo in interface XSL

Parameters:

xml - Source XML document

Returns:

Result text