← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/libjaxp1.3-java/gutsy

« back to all changes in this revision

Viewing changes to javax/xml/transform/sax/TransformerHandler.java

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Vandyck
  • Date: 2006-08-03 10:30:58 UTC
  • Revision ID: james.westby@ubuntu.com-20060803103058-7jwwiqv9g8w9094d
Tags: upstream-1.3.03
Import upstream version 1.3.03

Show diffs side-by-side

added added

removed removed

Lines of Context:
javax/xml/transform/sax/TransformerHandler.java
 
1
/*
 
2
 * Copyright 2003-2004 The Apache Software Foundation.
 
3
 *
 
4
 * Licensed under the Apache License, Version 2.0 (the "License");
 
5
 * you may not use this file except in compliance with the License.
 
6
 * You may obtain a copy of the License at
 
7
 *
 
8
 *     http://www.apache.org/licenses/LICENSE-2.0
 
9
 *
 
10
 * Unless required by applicable law or agreed to in writing, software
 
11
 * distributed under the License is distributed on an "AS IS" BASIS,
 
12
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
13
 * See the License for the specific language governing permissions and
 
14
 * limitations under the License.
 
15
 */
 
16
 
 
17
// $Id: TransformerHandler.java 226236 2005-06-17 03:10:33Z mrglavas $
 
18
 
 
19
package javax.xml.transform.sax;
 
20
 
 
21
import javax.xml.transform.Result;
 
22
import javax.xml.transform.Transformer;
 
23
 
 
24
import org.xml.sax.ContentHandler;
 
25
import org.xml.sax.DTDHandler;
 
26
import org.xml.sax.ext.LexicalHandler;
 
27
 
 
28
/**
 
29
 * A TransformerHandler
 
30
 * listens for SAX ContentHandler parse events and transforms
 
31
 * them to a Result.
 
32
 */
 
33
public interface TransformerHandler
 
34
    extends ContentHandler, LexicalHandler, DTDHandler {
 
35
 
 
36
    /**
 
37
     * <p>Set  the <code>Result</code> associated with this
 
38
     * <code>TransformerHandler</code> to be used for the transformation.</p>
 
39
     *
 
40
     * @param result A <code>Result</code> instance, should not be
 
41
     *   <code>null</code>.
 
42
     *
 
43
     * @throws IllegalArgumentException if result is invalid for some reason.
 
44
     */
 
45
    public void setResult(Result result) throws IllegalArgumentException;
 
46
 
 
47
    /**
 
48
     * Set the base ID (URI or system ID) from where relative
 
49
     * URLs will be resolved.
 
50
     * @param systemID Base URI for the source tree.
 
51
     */
 
52
    public void setSystemId(String systemID);
 
53
 
 
54
    /**
 
55
     * Get the base ID (URI or system ID) from where relative
 
56
     * URLs will be resolved.
 
57
     * @return The systemID that was set with {@link #setSystemId}.
 
58
     */
 
59
    public String getSystemId();
 
60
 
 
61
    /**
 
62
     * <p>Get the <code>Transformer</code> associated with this handler, which
 
63
     * is needed in order to set parameters and output properties.</p>
 
64
     * 
 
65
     * @return <code>Transformer</code> associated with this
 
66
     *   <code>TransformerHandler</code>.
 
67
     */
 
68
    public Transformer getTransformer();
 
69
}