View Javadoc
1   /*
2    * Copyright (c) 2012-2022, jcabi.com
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met: 1) Redistributions of source code must retain the above
8    * copyright notice, this list of conditions and the following
9    * disclaimer. 2) Redistributions in binary form must reproduce the above
10   * copyright notice, this list of conditions and the following
11   * disclaimer in the documentation and/or other materials provided
12   * with the distribution. 3) Neither the name of the jcabi.com nor
13   * the names of its contributors may be used to endorse or promote
14   * products derived from this software without specific prior written
15   * permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28   * OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package com.jcabi.xml;
31  
32  /**
33   * XSL stylesheet.
34   *
35   * <p>Implementation of this interface must be immutable and thread-safe.
36   *
37   * @see XSLDocument
38   * @since 0.4
39   * @checkstyle AbbreviationAsWordInNameCheck (5 lines)
40   */
41  public interface XSL {
42  
43      /**
44       * Transform XML to another one.
45       * @param xml Source XML document
46       * @return Result document
47       */
48      XML transform(XML xml);
49  
50      /**
51       * Transform XML into text.
52       * @param xml Source XML document
53       * @return Result text
54       * @since 0.11
55       */
56      String applyTo(XML xml);
57  
58      /**
59       * With this sources.
60       * @param src Sources
61       * @return New XSL document
62       */
63      XSL with(Sources src);
64  
65      /**
66       * With this parameter.
67       * @param name Name of XSL parameter
68       * @param value Value of XSL parameter
69       * @return New XSL document
70       * @since 0.16
71       */
72      XSL with(String name, Object value);
73  
74  }