Class RasterFunctionArguments


  • public final class RasterFunctionArguments
    extends java.lang.Object
    Represents arguments associated with a raster function.
    Since:
    100.0.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getArgumentNames()
      Gets names of all arguments.
      java.util.List<java.lang.String> getRasterNames()
      Gets a list of raster names associated with the corresponding raster function.
      void setArgument​(java.lang.String argumentName, java.lang.String argumentValue)
      Sets the argument value for the given argument name.
      void setRaster​(java.lang.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 java.util.List<java.lang.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​(java.lang.String argumentName,
                                java.lang.String argumentValue)
        Sets the argument value for the given argument name.
        Parameters:
        argumentName - argument name
        argumentValue - argument value
        Throws:
        java.lang.IllegalArgumentException - if argumentName is null or empty
        Since:
        100.0.0
      • getRasterNames

        public java.util.List<java.lang.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​(java.lang.String rasterName,
                              Raster raster)
        Sets the raster for the provided raster name.
        Parameters:
        rasterName - name of the raster to set
        raster - raster
        Throws:
        java.lang.IllegalArgumentException - if rasterName is null or empty
        java.lang.IllegalArgumentException - if raster is null
        Since:
        100.0.0