geotrellis.engine.OperationResult.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geotrellis-engine_2.11 Show documentation

GeoTrellis is an open source geographic data processing engine for high performance applications.

There is a newer version: 0.10.3

Show newest version

/*
 * Copyright (c) 2014 Azavea.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package geotrellis.engine

/**
 * OperationResult contains an operation's results.
 *
 * This could include the resulting value the operation produced, an error
 * that prevented the operation from completing, and the history of the
 * operation.
 */
sealed trait OperationResult[+T]

/**
 * Internal version to include Inlined;
 * outside match statements shouldn't get warned about
 * not handling an Inlined case since they should never leak outside.
 */
private[engine]
sealed trait InternalOperationResult[+T]

/**
 * OperationResult for an operation which was a literal argument.
 *
 * Instances of Inlined should never leak out of the actor world. E.g. messages
 * sent to clients in the GeoTrellis world should either be Complete or Failure.
 *
 * Inlined exists because these arguments don't have useful history, and
 * Calculations need to distinguish them from Complete results (which were
 * calculated operations with history).
 */
private[engine]
case class Inlined[T](value:T) extends InternalOperationResult[T]

/**
 * OperationResult for a successful operation.
 */
@deprecated("geotrellis-engine has been deprecated", "Geotrellis Version 0.10")
case class Complete[T](value:T, history:History) extends OperationResult[T]
                                                    with InternalOperationResult[T]

/**
 * OperationResult for a failed operation.
 */
@deprecated("geotrellis-engine has been deprecated", "Geotrellis Version 0.10")
case class Error(message:String, history:History) extends OperationResult[Nothing]
                                                     with InternalOperationResult[Nothing]