com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CreateFolder

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.CreateFolder

All Implemented Interfaces:

GPTool

public class CreateFolder
extends AbstractGPTool

Creates a folder at the output location. The Create Folder tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The Output folder should not already exist. An error will not occur if the folder already exists.
• The environment settings do not have an effect on this tool.
• The following environment settings affect this tool: workspace; and scratch workspace;

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CreateFolder()
Creates the Create Folder tool with defaults.

CreateFolder(Object outFolderPath, String outName)
Creates the Create Folder tool with the required parameters.

Method Summary

Object	getOutFolder() Returns the Output Folder parameter of this tool (Read only).
Object	getOutFolderPath() Returns the Folder Location parameter of this tool .
String	getOutName() Returns the Folder Name parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setOutFolderPath(Object outFolderPath) Sets the Folder Location parameter of this tool .
void	setOutName(String outName) Sets the Folder Name parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFolder

public CreateFolder()

Creates the Create Folder tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

CreateFolder

public CreateFolder(Object outFolderPath,
                    String outName)

Creates the Create Folder tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

outFolderPath - Folder, the existing location where the folder will be created.

outName - String, the folder to be created.

Method Detail

getOutFolderPath

public Object getOutFolderPath()

Returns the Folder Location parameter of this tool . This parameter is Folder, the existing location where the folder will be created. This is a required parameter.

Returns:

the Folder Location

setOutFolderPath

public void setOutFolderPath(Object outFolderPath)

Sets the Folder Location parameter of this tool . This parameter is Folder, the existing location where the folder will be created. This is a required parameter.

Parameters:

outFolderPath - Folder, the existing location where the folder will be created.

getOutName

public String getOutName()

Returns the Folder Name parameter of this tool . This parameter is String, the folder to be created. This is a required parameter.

Returns:

the Folder Name

setOutName

public void setOutName(String outName)

Sets the Folder Name parameter of this tool . This parameter is String, the folder to be created. This is a required parameter.

Parameters:

outName - String, the folder to be created.

getOutFolder

public Object getOutFolder()

Returns the Output Folder parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Folder

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias