public class

GPLinearUnit

extends GPParameter
java.lang.Object
   ↳ com.esri.core.tasks.ags.geoprocessing.GPParameter
     ↳ com.esri.core.tasks.ags.geoprocessing.GPLinearUnit

Class Overview

Container class representing a Geo-Processing parameter of the type linear unit.

Summary

[Expand]
Inherited Constants
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
[Expand]
Inherited Fields
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
Public Constructors
GPLinearUnit(String paramName)
Constructor taking in the parameter name.
GPLinearUnit()
Constructs an empty GPLinearUnit object.
Public Methods
boolean equals(Object obj)
void fromJson(JsonParser parser)
Method used to populate a GP Parameter.
String generateValueParams()
Method serializing GP parameter's values into a Json format.
double getDistance()
Gets the distance value.
String getUnits()
Gets the units in string.
int hashCode()
void setDistance(double distance)
Sets the distance value.
void setUnits(String units)
Sets the units in string.
String toString()
[Expand]
Inherited Methods
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
From class java.lang.Object

Public Constructors

public GPLinearUnit (String paramName)

Constructor taking in the parameter name.

Parameters
paramName String: parameter name.

public GPLinearUnit ()

Constructs an empty GPLinearUnit object.

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public void fromJson (JsonParser parser)

Method used to populate a GP Parameter.

Parameters
parser JsonParser: a Json Parser
Throws
Exception

public String generateValueParams ()

Method serializing GP parameter's values into a Json format.

Returns
String the Json String containing the GP parameter's values.
Throws
Exception

public double getDistance ()

Gets the distance value.

Returns
double the distance.

public String getUnits ()

Gets the units in string. Such as "esriMeters", "esriMiles", "esriKilometers" etc.

Returns
String the units.

public int hashCode ()

Returns
int

public void setDistance (double distance)

Sets the distance value.

Parameters
distance double: the distance to set.

public void setUnits (String units)

Sets the units in string. Such as "esriMeters", "esriMiles", "esriKilometers" etc.

Parameters
units String: the units to set

public String toString ()

Returns
String