XSLDocument (jcabi-xml 0.21.5 API)

java.lang.Object
- com.jcabi.xml.XSLDocument

All Implemented Interfaces:

XSL
```
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: 4c9cd50c02a13103bb566e0e6f8a715a9fcc827d $

Author:

Yegor Bugayenko (yegor256@gmail.com)

Suppressed Checkstyle violations:

ClassDataAbstractionCouplingCheck (500 lines), AbbreviationAsWordInNameCheck (5 lines), ClassFanOutComplexityCheck (500 lines)

Field Summary

Fields
Modifier and Type Field and Description

static XSL STRIP
Strips spaces of whitespace-only text nodes.

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

Constructor Summary

Constructors
Constructor and Description
`XSLDocument(File file)` Public ctor, from file.
`XSLDocument(InputStream stream)` Public ctor, from XSL as an input stream.
`XSLDocument(InputStream stream, String base)` Public ctor, from XSL as an input stream.
`XSLDocument(Path file)` Public ctor, from file.
`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,Object> map)` Public ctor, from XSL as a string.
`XSLDocument(String src, Sources srcs, Map<String,Object> map, String base)` Public ctor, from XSL as a string.
`XSLDocument(String src, Sources srcs, String base)` Public ctor, from XSL as a string.
`XSLDocument(String src, String base)` 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.
`XSLDocument(XML src, String base)` Public ctor, from XML as a source.

Method Summary

All Methods Static Methods Instance Methods Concrete 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, Object 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:
```
 
 &lt;a&gt;
           &lt;b> TXT &lt;/b>
    &lt;/a>
 
```
    becomes
```
 
 &lt;a>
     &lt;b> TXT &lt;/b>
 &lt;/a>
 
```
    Since:
    
    0.14
- Constructor Detail
  - XSLDocument
```
public XSLDocument(XML src)
```
    Public ctor, from XML as a source.
    
    Parameters:
    
    src - XSL document body
  - XSLDocument
```
public XSLDocument(XML src,
                   String base)
```
    Public ctor, from XML as a source.
    
    Parameters:
    
    src - XSL document body
    
    base - SystemId/Base
    
    Since:
    
    0.20
  - XSLDocument
```
public XSLDocument(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(File file)
            throws FileNotFoundException
```
    Public ctor, from file.
    
    Parameters:
    
    file - Location of document
    
    Throws:
    
    FileNotFoundException - If fails to read
    
    Since:
    
    0.21
  - XSLDocument
```
public XSLDocument(Path file)
            throws FileNotFoundException
```
    Public ctor, from file.
    
    Parameters:
    
    file - Location of document
    
    Throws:
    
    FileNotFoundException - If fails to read
    
    Since:
    
    0.21
  - XSLDocument
```
public XSLDocument(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(InputStream stream)
```
    Public ctor, from XSL as an input stream.
    
    Parameters:
    
    stream - XSL input stream
  - XSLDocument
```
public XSLDocument(InputStream stream,
                   String base)
```
    Public ctor, from XSL as an input stream.
    
    Parameters:
    
    stream - XSL input stream
    
    base - SystemId/Base
    
    Since:
    
    0.20
  - XSLDocument
```
public XSLDocument(String src)
```
    Public ctor, from XSL as a string.
    
    Parameters:
    
    src - XML document body
  - XSLDocument
```
public XSLDocument(String src,
                   String base)
```
    Public ctor, from XSL as a string.
    
    Parameters:
    
    src - XML document body
    
    base - SystemId/Base
    
    Since:
    
    0.20
  - 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(String src,
                   Sources srcs,
                   String base)
```
    Public ctor, from XSL as a string.
    
    Parameters:
    
    src - XML document body
    
    srcs - Sources
    
    base - SystemId/Base
    
    Since:
    
    0.20
  - XSLDocument
```
public XSLDocument(String src,
                   Sources srcs,
                   Map<String,Object> map)
```
    Public ctor, from XSL as a string.
    
    Parameters:
    
    src - XML document body
    
    srcs - Sources
    
    map - Map of XSL params
    
    Since:
    
    0.16
  - XSLDocument
```
public XSLDocument(String src,
                   Sources srcs,
                   Map<String,Object> map,
                   String base)
```
    Public ctor, from XSL as a string.
    
    Parameters:
    
    src - XML document body
    
    srcs - Sources
    
    map - Map of XSL params
    
    base - SystemId/Base
    
    Since:
    
    0.20
    
    Suppressed Checkstyle violations:
    
    ParameterNumberCheck (5 lines)
- Method Detail
  - with
```
public XSL with(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(String name,
                Object 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(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(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
```
public XML transform(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(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

Class XSLDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STRIP

Constructor Detail

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

XSLDocument

Method Detail

with

with

make

make

toString

transform

applyTo