AbstractCXFToolContainer (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.tools.common.toolspec.AbstractToolContainer
- - org.apache.cxf.tools.common.AbstractCXFToolContainer

All Implemented Interfaces:

ToolContainer

Direct Known Subclasses:

IDLToWSDL, JavaToJS, JavaToWSContainer, JAXRSContainer, WSDLToIDL, WSDLToJavaContainer, WSDLToService, WSDLToSoap, WSDLToXML, WSDLValidator, XSDToWSDL
```
public abstract class AbstractCXFToolContainer
extends AbstractToolContainer
```
Common processing for the CXF tools. Processes common options.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.cxf.tools.common.toolspec.AbstractToolContainer
  AbstractToolContainer.GenericOutputStream

Field Summary

Fields
Modifier and Type Field and Description

protected static Logger LOG
- Fields inherited from class org.apache.cxf.tools.common.toolspec.AbstractToolContainer
  context, err, out, toolspec

Fields
Modifier and Type	Field and Description
`protected static Logger`	`LOG`

Constructor Summary

Constructors
Constructor and Description

AbstractCXFToolContainer(String nm, ToolSpec toolspec)

Constructors
Constructor and Description
`AbstractCXFToolContainer(String nm, ToolSpec toolspec)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkParams(ErrorVisitor err)` Check command-line parameters for validity.
`protected ClassCollector`	`createClassCollector()`
`void`	`execute(boolean exitOnFinish)`
`protected String[]`	`getDefaultExcludedNamespaces(String excludeProps)`
`String`	`getFileBase(String wsdlUrl)`
`String`	`getFileName(String loc)`
`protected Map<String,Object>`	`getParametersMap(Set<String> stringArrayKeys)` get all parameters in a map
`String`	`getToolName()`
`String`	`getUsage()`
`boolean`	`hasInfoOption()`
`boolean`	`isVerboseOn()`
`Properties`	`loadProperties(InputStream inputs)`
`Properties`	`loadProperties(String propertyFile)`
`void`	`outputFullCommandLine()`
`void`	`outputVersion()`
`void`	`printUsageException(String toolName, BadUsageException ex)`

Methods inherited from class org.apache.cxf.tools.common.toolspec.AbstractToolContainer
getArgument, getBus, getCatalogURL, getCommandDocument, getCommandLineParser, getContext, getErrOutputStream, getOutOutputStream, init, isQuietMode, isVerboseMode, parseCommandLine, redirectOutput, setArguments, setContext, setErrOutputStream, setMode, setOutOutputStream, tearDown

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

Field Detail
- LOG
```
protected static final Logger LOG
```

Constructor Detail

AbstractCXFToolContainer

public AbstractCXFToolContainer(String nm,
                        ToolSpec toolspec)
                         throws Exception

Throws:: Exception

Method Detail

hasInfoOption

public boolean hasInfoOption()
                      throws ToolException

Throws:: ToolException

execute
```
public void execute(boolean exitOnFinish)
             throws ToolException
```
Specified by:

execute in interface ToolContainer

Overrides:

execute in class AbstractToolContainer

Throws:

ToolException

checkParams
```
public void checkParams(ErrorVisitor err)
                 throws ToolException
```
Check command-line parameters for validity. Since subclasses delegate down to here, this cannot complain about unwanted options.

Parameters:
err - place to report errors.

Throws:

ToolException - for impossible options.

isVerboseOn
```
public boolean isVerboseOn()
```

getToolName
```
public String getToolName()
```

getUsage
```
public String getUsage()
```

outputVersion
```
public void outputVersion()
```

outputFullCommandLine
```
public void outputFullCommandLine()
```

getFileBase

public String getFileBase(String wsdlUrl)

printUsageException

public void printUsageException(String toolName,
                       BadUsageException ex)

getFileName

public String getFileName(String loc)

loadProperties

public Properties loadProperties(InputStream inputs)

loadProperties

public Properties loadProperties(String propertyFile)

getDefaultExcludedNamespaces

protected String[] getDefaultExcludedNamespaces(String excludeProps)

getParametersMap
```
protected Map<String,Object> getParametersMap(Set<String> stringArrayKeys)
```
get all parameters in a map

Parameters:
stringArrayKeys, - contains keys, whose value should be string array

createClassCollector

protected ClassCollector createClassCollector()

Class AbstractCXFToolContainer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.tools.common.toolspec.AbstractToolContainer

Field Summary

Fields inherited from class org.apache.cxf.tools.common.toolspec.AbstractToolContainer

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.tools.common.toolspec.AbstractToolContainer

Methods inherited from class java.lang.Object

Field Detail

LOG

Constructor Detail

AbstractCXFToolContainer

Method Detail

hasInfoOption

execute

checkParams

isVerboseOn

getToolName

getUsage

outputVersion

outputFullCommandLine

getFileBase

printUsageException

getFileName

loadProperties

loadProperties

getDefaultExcludedNamespaces

getParametersMap

createClassCollector