Apache CXF API

org.apache.cxf.tools.common.toolspec
Class ToolSpec

java.lang.Object
  extended by org.apache.cxf.tools.common.toolspec.ToolSpec

public class ToolSpec
extends Object


Constructor Summary
ToolSpec()
           
ToolSpec(Document d)
           
ToolSpec(InputStream in)
           
ToolSpec(InputStream in, boolean validate)
           
 
Method Summary
 String getAnnotation()
           
 ExtendedDocumentBuilder getDocumentBuilder()
           
 Element getElementById(String id)
           
 Tool getHandler()
           
 Tool getHandler(ClassLoader loader)
           
 List getInstreamIds()
           
 List getOutstreamIds()
           
 String getParameterDefault(String name)
           
 Element getPipeline()
           
 String getStreamRefName(String streamId)
          Arguments can have streamref attributes which associate them with a stream.
 Element getStreams()
           
 Element getUsage()
           
 List<Element> getUsageForms()
           
 boolean hasHandler()
           
 boolean isValidInputStream(String id)
           
 void transform(InputStream stylesheet, OutputStream out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToolSpec

public ToolSpec()

ToolSpec

public ToolSpec(InputStream in)
         throws ToolException
Throws:
ToolException

ToolSpec

public ToolSpec(InputStream in,
                boolean validate)
         throws ToolException
Throws:
ToolException

ToolSpec

public ToolSpec(Document d)
Method Detail

getDocumentBuilder

public ExtendedDocumentBuilder getDocumentBuilder()

isValidInputStream

public boolean isValidInputStream(String id)

getElementById

public Element getElementById(String id)

hasHandler

public boolean hasHandler()

getHandler

public Tool getHandler()
                throws ToolException
Throws:
ToolException

getHandler

public Tool getHandler(ClassLoader loader)
                throws ToolException
Throws:
ToolException

getStreams

public Element getStreams()

getInstreamIds

public List getInstreamIds()

getOutstreamIds

public List getOutstreamIds()

getUsage

public Element getUsage()

transform

public void transform(InputStream stylesheet,
                      OutputStream out)
               throws TransformerException
Throws:
TransformerException

getPipeline

public Element getPipeline()

getUsageForms

public List<Element> getUsageForms()

getStreamRefName

public String getStreamRefName(String streamId)
Arguments can have streamref attributes which associate them with a stream. Tools usually request streams and rely on them being ready. If an argument is given a streamref, then the container constructs a stream from the argument value. This would usually be a simple FileInputStream or FileOutputStream. The mechanics of this are left for the container to sort out, but that is the reason why this getter method exists.


getParameterDefault

public String getParameterDefault(String name)

getAnnotation

public String getAnnotation()

Apache CXF API

Apache CXF