com.telly.groundy.Succeeded Maven / Gradle / Ivy

Go to download
/**
 * Copyright Telly, Inc. and other Groundy contributors.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do so, subject to the
 * following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
 * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.telly.groundy;

/**
 * Use this {@link TaskResult} if the value succeeded to do its job. You can optionally pass a
 * bundle
 * with some return parameters; those parameters will be match with the method callback parameters.
 * 
 * For instance, if you pass a Bundle with a long param whose key is "time", you must annotate your
 * callback method with {@link com.telly.groundy.annotations.OnSuccess}, annotate a long parameter
 * with {@link com.telly.groundy.annotations.Param} and the value "time".
 */
final class Succeeded extends TaskResult {
  Succeeded() {
    super(ResultType.SUCCESS);
  }
}