Package com.esri.arcgisruntime.raster

Class RasterFunctionArguments

java.lang.Object

com.esri.arcgisruntime.raster.RasterFunctionArguments

public final class RasterFunctionArguments
extends Object

Represents arguments associated with a raster function.

Since:

100.0.0

Method Summary

Modifier and Type	Method	Description
List<String>	getArgumentNames()	Gets names of all arguments.
List<String>	getRasterNames()	Gets a list of raster names associated with the corresponding raster function.
void	setArgument(String argumentName, String argumentValue)	Sets the argument value for the given argument name.
void	setRaster(String rasterName, Raster raster)	Sets the raster for the provided raster name.

Methods inherited from class java.lang.Object

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

Method Detail

getArgumentNames

public List<String> getArgumentNames()

Gets names of all arguments.

Returns:

an unmodifiable list containing names of all arguments. This will throw an UnsupportedOperationException if an attempt is made to modify it

Since:

100.0.0

setArgument

public void setArgument(String argumentName,
                        String argumentValue)

Sets the argument value for the given argument name.

Parameters:

argumentName - argument name

argumentValue - argument value

Throws:

IllegalArgumentException - if argumentName is null or empty

Since:

100.0.0

getRasterNames

public List<String> getRasterNames()

Gets a list of raster names associated with the corresponding raster function.

Returns:

an unmodifiable list of raster names. This will throw an UnsupportedOperationException if an attempt is made to modify it

Since:

100.0.0

setRaster

public void setRaster(String rasterName,
                      Raster raster)

Sets the raster for the provided raster name.

Parameters:

rasterName - name of the raster to set

raster - raster

Throws:

IllegalArgumentException - if rasterName is null or empty

IllegalArgumentException - if raster is null

Since:

100.0.0