java.lang.Object
- com.sun.xml.rpc.util.ToolBase
- - com.sun.xml.rpc.tools.wscompile.CompileTool

All Implemented Interfaces:

ProcessorNotificationListener, CompileTool

Direct Known Subclasses:

EndpointClientCompileTool, EndpointCompileTool
```
public class CompileTool
extends ToolBase
implements ProcessorNotificationListener, CompileTool
```
Author:

JAX-RPC Development Team

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map`	`actions`
`protected boolean`	`compilerDebug`
`protected boolean`	`compilerOptimize`
`protected File`	`configFile`
`protected Configuration`	`configuration`
`protected File`	`debugModelFile`
`protected CompileToolDelegate`	`delegate`
`protected File`	`destDir`
`protected boolean`	`doNothing`
`protected boolean`	`donotOverride`
`protected boolean`	`dontGenerateRPCStructures`
`protected boolean`	`dontGenerateWrapperClasses`
`protected ProcessorEnvironment`	`environment`
`protected boolean`	`explicitServiceContext`
`protected boolean`	`generateOneWayMethods`
`protected boolean`	`jaxbEnumType`
`protected boolean`	`keepGenerated`
`protected ProcessorNotificationListener`	`listener`
`protected int`	`mode`
`protected static int`	`MODE_DEFINE`
`protected static int`	`MODE_GEN_BOTH`
`protected static int`	`MODE_GEN_CLIENT`
`protected static int`	`MODE_GEN_SERVER`
`protected static int`	`MODE_IMPORT`
`protected static int`	`MODE_UNSPECIFIED`
`protected File`	`modelFile`
`protected boolean`	`noDataBinding`
`protected boolean`	`noEncodedTypes`
`protected boolean`	`noMultiRefEncoding`
`protected File`	`nonclassDestDir`
`protected boolean`	`noValidation`
`protected boolean`	`printStackTrace`
`protected Processor`	`processor`
`protected Properties`	`properties`
`protected boolean`	`resolveIDREF`
`protected boolean`	`searchSchemaForSubtypes`
`protected boolean`	`serializable`
`protected boolean`	`serializeInterfaces`
`protected String`	`serializerInfix`
`protected File`	`sourceDir`
`protected boolean`	`strictCompliance`
`protected String`	`targetVersion`
`protected boolean`	`unwrapDocLitWrappers`
`protected boolean`	`useDataHandlerOnly`
`protected boolean`	`useDocLiteralEncoding`
`protected String`	`userClasspath`
`protected boolean`	`useRPCLiteralEncoding`
`protected boolean`	`useWSIBasicProfile`
`protected boolean`	`verbose`
`protected boolean`	`wrapperFlagSeen`

Fields inherited from class com.sun.xml.rpc.util.ToolBase
FALSE, localizer, messageFactory, out, program, TRUE

Constructor Summary

Constructors
Constructor Description

CompileTool(OutputStream out, String program)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`afterHook()`
`protected void`	`beforeHook()`
`protected void`	`compileGeneratedClasses()`
`protected String`	`createClasspathString()`
`protected Configuration`	`createConfiguration()`
`protected ProcessorEnvironment`	`createEnvironment()`
`protected ProcessorAction`	`getAction(String name)`
`ProcessorEnvironment`	`getEnvironment()`
`protected String`	`getGenericErrorMessage()`
`Processor`	`getProcessor()`
`protected String`	`getResourceBundleName()`
`protected String`	`getSourceVersion()`
`Localizable`	`getVersion()`
`String`	`getVersionString()`
`protected void`	`help()`
`protected void`	`initialize()`
`void`	`onError(Localizable msg)`
`void`	`onInfo(Localizable msg)`
`void`	`onWarning(Localizable msg)`
`protected boolean`	`parseArguments(String[] args)`
`void`	`printStackTrace(Throwable t)`
`protected void`	`registerProcessorActions(Processor processor)`
`void`	`removeGeneratedFiles()`
`protected void`	`resetOptionsForTargetVersion()`
`void`	`run()`	Which one should we use? run() or run(String args[]).
`void`	`setDelegate(CompileToolDelegate delegate)`
`protected void`	`setEnvironmentValues(ProcessorEnvironment env)`
`protected void`	`usage()`
`boolean`	`wasSuccessful()`
`protected void`	`withModelHook()`

Methods inherited from class com.sun.xml.rpc.util.ToolBase
getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, report, report, run

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.xml.rpc.spi.tools.CompileTool
run

Field Detail

properties
```
protected Properties properties
```

environment

protected ProcessorEnvironment environment

configuration
```
protected Configuration configuration
```

processor
```
protected Processor processor
```

listener

protected ProcessorNotificationListener listener

actions
```
protected Map actions
```

delegate
```
protected CompileToolDelegate delegate
```

configFile
```
protected File configFile
```

modelFile
```
protected File modelFile
```

sourceDir
```
protected File sourceDir
```

destDir
```
protected File destDir
```

nonclassDestDir
```
protected File nonclassDestDir
```

debugModelFile
```
protected File debugModelFile
```

mode
```
protected int mode
```

doNothing
```
protected boolean doNothing
```

compilerDebug
```
protected boolean compilerDebug
```

compilerOptimize
```
protected boolean compilerOptimize
```

verbose
```
protected boolean verbose
```

noDataBinding
```
protected boolean noDataBinding
```

noEncodedTypes
```
protected boolean noEncodedTypes
```

noMultiRefEncoding
```
protected boolean noMultiRefEncoding
```

noValidation
```
protected boolean noValidation
```

explicitServiceContext

protected boolean explicitServiceContext

printStackTrace
```
protected boolean printStackTrace
```

keepGenerated
```
protected boolean keepGenerated
```

serializable
```
protected boolean serializable
```

donotOverride
```
protected boolean donotOverride
```

serializeInterfaces
```
protected boolean serializeInterfaces
```

searchSchemaForSubtypes

protected boolean searchSchemaForSubtypes

useDataHandlerOnly
```
protected boolean useDataHandlerOnly
```

dontGenerateRPCStructures

protected boolean dontGenerateRPCStructures

useDocLiteralEncoding

protected boolean useDocLiteralEncoding

useRPCLiteralEncoding

protected boolean useRPCLiteralEncoding

useWSIBasicProfile
```
protected boolean useWSIBasicProfile
```

generateOneWayMethods

protected boolean generateOneWayMethods

resolveIDREF
```
protected boolean resolveIDREF
```

strictCompliance
```
protected boolean strictCompliance
```

jaxbEnumType
```
protected boolean jaxbEnumType
```

unwrapDocLitWrappers
```
protected boolean unwrapDocLitWrappers
```

wrapperFlagSeen
```
protected boolean wrapperFlagSeen
```

dontGenerateWrapperClasses

protected boolean dontGenerateWrapperClasses

targetVersion
```
protected String targetVersion
```

serializerInfix
```
protected String serializerInfix
```

userClasspath
```
protected String userClasspath
```

MODE_UNSPECIFIED
```
protected static final int MODE_UNSPECIFIED
```
See Also:

Constant Field Values

MODE_IMPORT
```
protected static final int MODE_IMPORT
```
See Also:

Constant Field Values

MODE_DEFINE
```
protected static final int MODE_DEFINE
```
See Also:

Constant Field Values

MODE_GEN_CLIENT
```
protected static final int MODE_GEN_CLIENT
```
See Also:

Constant Field Values

MODE_GEN_SERVER
```
protected static final int MODE_GEN_SERVER
```
See Also:

Constant Field Values

MODE_GEN_BOTH
```
protected static final int MODE_GEN_BOTH
```
See Also:

Constant Field Values

Constructor Detail

CompileTool

public CompileTool(OutputStream out,
                   String program)

Method Detail

initialize
```
protected void initialize()
```
Overrides:

initialize in class ToolBase

getEnvironment
```
public ProcessorEnvironment getEnvironment()
```
Specified by:

getEnvironment in interface CompileTool

getProcessor
```
public Processor getProcessor()
```
Specified by:

getProcessor in interface CompileTool

setDelegate

public void setDelegate(CompileToolDelegate delegate)

Specified by:: setDelegate in interface CompileTool

parseArguments
```
protected boolean parseArguments(String[] args)
```
Specified by:

parseArguments in class ToolBase

resetOptionsForTargetVersion

protected void resetOptionsForTargetVersion()

getVersion
```
public Localizable getVersion()
```

getVersionString
```
public String getVersionString()
```

usage
```
protected void usage()
```

help
```
protected void help()
```

run
```
public void run()
         throws Exception
```
Description copied from interface: CompileTool

Which one should we use? run() or run(String args[]). We have to define setters for each arguments if we were to use run();

Specified by:

run in interface CompileTool

Specified by:

run in class ToolBase

Throws:

Exception

wasSuccessful
```
public boolean wasSuccessful()
```
Overrides:

wasSuccessful in class ToolBase

getGenericErrorMessage
```
protected String getGenericErrorMessage()
```
Specified by:

getGenericErrorMessage in class ToolBase

getResourceBundleName
```
protected String getResourceBundleName()
```
Specified by:

getResourceBundleName in class ToolBase

printStackTrace
```
public void printStackTrace(Throwable t)
```
Overrides:

printStackTrace in class ToolBase

beforeHook
```
protected void beforeHook()
```

getSourceVersion
```
protected String getSourceVersion()
```
Returns:

the JAX-RPC version, 1.1.3 if none specified as target

withModelHook
```
protected void withModelHook()
```

afterHook
```
protected void afterHook()
```

removeGeneratedFiles
```
public void removeGeneratedFiles()
```

createEnvironment

protected ProcessorEnvironment createEnvironment()
                                          throws Exception

Throws:: Exception

setEnvironmentValues

protected void setEnvironmentValues(ProcessorEnvironment env)

createConfiguration

protected Configuration createConfiguration()
                                     throws Exception

Throws:: Exception

registerProcessorActions

protected void registerProcessorActions(Processor processor)

createClasspathString

protected String createClasspathString()

compileGeneratedClasses

protected void compileGeneratedClasses()

getAction

protected ProcessorAction getAction(String name)

onError
```
public void onError(Localizable msg)
```
Specified by:

onError in interface ProcessorNotificationListener

onWarning
```
public void onWarning(Localizable msg)
```
Specified by:

onWarning in interface ProcessorNotificationListener

onInfo
```
public void onInfo(Localizable msg)
```
Specified by:

onInfo in interface ProcessorNotificationListener

Class CompileTool

Field Summary

Fields inherited from class com.sun.xml.rpc.util.ToolBase

Constructor Summary

Method Summary

Methods inherited from class com.sun.xml.rpc.util.ToolBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.sun.xml.rpc.spi.tools.CompileTool

Field Detail

properties

environment

configuration

processor

listener

actions

delegate

configFile

modelFile

sourceDir

destDir

nonclassDestDir

debugModelFile

mode

doNothing

compilerDebug

compilerOptimize

verbose

noDataBinding

noEncodedTypes

noMultiRefEncoding

noValidation

explicitServiceContext

printStackTrace

keepGenerated

serializable

donotOverride

serializeInterfaces

searchSchemaForSubtypes

useDataHandlerOnly

dontGenerateRPCStructures

useDocLiteralEncoding

useRPCLiteralEncoding

useWSIBasicProfile

generateOneWayMethods

resolveIDREF

strictCompliance

jaxbEnumType

unwrapDocLitWrappers

wrapperFlagSeen

dontGenerateWrapperClasses

targetVersion

serializerInfix

userClasspath

MODE_UNSPECIFIED

MODE_IMPORT

MODE_DEFINE

MODE_GEN_CLIENT

MODE_GEN_SERVER

MODE_GEN_BOTH

Constructor Detail

CompileTool

Method Detail

initialize

getEnvironment

getProcessor

setDelegate

parseArguments

resetOptionsForTargetVersion

getVersion

getVersionString

usage

help

run

wasSuccessful

getGenericErrorMessage

getResourceBundleName

printStackTrace

beforeHook

getSourceVersion

withModelHook