Package

org.scalatra

commands

Permalink

package commands

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. commands
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class AsyncCommandExecutor[T <: Command, S] extends AsyncExecutor[T, S]

    Permalink

    A command executor that doesn't block while executing the command

    A command executor that doesn't block while executing the command

    T

    The type of command to handle

    S

    The success result type

    See also

    org.scalatra.commands.CommandExecutor

  2. abstract class AsyncExecutor[T <: Command, S] extends CommandExecutor[T, Future[ModelValidation[S]]]

    Permalink
  3. class AsyncModelExecutor[T <: Command, S] extends AsyncExecutor[T, S]

    Permalink

    A command executor that can potentially block while executing the command, uses a model as input value for the handler function.

    A command executor that can potentially block while executing the command, uses a model as input value for the handler function. This command requires an implicit conversion from command to model to be in scope ie.: by defining it in the companion object of the command.

    T

    The type of model

    S

    The success result type

    See also

    org.scalatra.commands.CommandExecutor

  4. class BasicFieldDescriptor[T] extends FieldDescriptor[T]

    Permalink
  5. sealed trait Binding extends AnyRef

    Permalink
  6. type BindingAction = () ⇒ Any

    Permalink
  7. class BindingException extends ScalatraException

    Permalink
  8. trait BindingImplicits extends DefaultImplicitConversions with BindingValidatorImplicits

    Permalink

    Commonly-used field implementations factory.

  9. trait BindingSyntax extends BindingValidatorImplicits

    Permalink
  10. type BindingValidator[T] = (String) ⇒ Validator[T]

    Permalink
  11. trait BindingValidatorImplicits extends AnyRef

    Permalink
  12. class BlockingCommandExecutor[T <: Command, S] extends BlockingExecutor[T, S]

    Permalink

    A command executor that can potentially block while executing the command

    A command executor that can potentially block while executing the command

    T

    The type of command to handle

    S

    The success result type

    See also

    org.scalatra.commands.CommandExecutor

  13. abstract class BlockingExecutor[T <: Command, S] extends CommandExecutor[T, ModelValidation[S]]

    Permalink
  14. class BlockingModelExecutor[T <: Command, S] extends BlockingExecutor[T, S]

    Permalink

    A command executor that can potentially block while executing the command, uses a model as input value for the handler function.

    A command executor that can potentially block while executing the command, uses a model as input value for the handler function. This command requires an implicit conversion from command to model to be in scope ie.: by defining it in the companion object of the command.

    T

    The type of model

    S

    The success result type

    See also

    org.scalatra.commands.CommandExecutor

  15. class BoundFieldDescriptor[S, T] extends DataboundFieldDescriptor[S, T]

    Permalink
  16. trait Command extends BindingSyntax with ParamsValueReaderProperties

    Permalink

    Trait that identifies a Command object, i.e.

    Trait that identifies a Command object, i.e. a Scala class instance which fields are bound to external parameters taken from Scalatra' params object.

    An usage example can be seen below:

    class PersonForm extends Command {
    
     import Command._
    
     val name = bind[String]("f_name")
     val surname = bind[String]("f_surname")
     val age = bind[Int]("f_age")
     val registeredOn = bind[Date]("f_reg_date" -> "yyyyMMdd")
    }

    In the example above, class field name will be bound, at runtime, with a parameter named f_name and so on. The binding is typed and for every registered type T (see org.scalatra.util.conversion.DefaultImplicitConversions for a list of all availables) an automatic conversion (String) => T will take place during binding phase.

    After that binding has been performed (i.e. after that org.scalatra.commands.Command#bindTo() has been called) on a specific instance, it is possible retrieve field values as scalaz.Validation, i.e.:

    val form = new PersonForm
    form.doBinding(params)
    val registrationDate = form.registeredOn.value.getOrElse(new Date())
    Version

    0.1

  17. abstract class CommandExecutor[T <: Command, S] extends AnyRef

    Permalink

    A typeclass for executing commands.

    A typeclass for executing commands. This allows for picking an executor based on the return type of the method that is used to handle the command.

    T

    The command type

    S

    The result type of executing the command

    Annotations
    @implicitNotFound( ... )
  18. trait CommandExecutors extends AnyRef

    Permalink
  19. trait CommandSupport extends ParamsValueReaderProperties with CommandExecutors

    Permalink

    Support for org.scalatra.commands.Command binding and validation.

  20. trait DataboundFieldDescriptor[S, T] extends FieldDescriptor[T]

    Permalink
  21. trait DateParser extends AnyRef

    Permalink
  22. class DefVal[T] extends AnyRef

    Permalink
  23. class Field[A] extends AnyRef

    Permalink
  24. trait FieldDescriptor[T] extends AnyRef

    Permalink
  25. type FieldValidation[T] = Validation[ValidationError, T]

    Permalink
  26. trait JacksonJsonParsing extends CommandSupport with JacksonJsonValueReaderProperty

    Permalink
  27. trait JsonBindingImplicits extends BindingImplicits with JsonImplicitConversions

    Permalink
  28. trait JsonCommand extends Command with JsonTypeConverterFactories

    Permalink
  29. trait JsonTypeConverterFactories extends JsonBindingImplicits

    Permalink
  30. class JsonTypeConverterFactoriesImports extends JsonTypeConverterFactories

    Permalink
  31. trait JsonTypeConverterFactory[T] extends TypeConverterFactory[T] with JsonBindingImplicits

    Permalink
  32. type ModelValidation[T] = Validation[NonEmptyList[ValidationError], T]

    Permalink
  33. trait NativeJsonParsing extends CommandSupport with NativeJsonValueReaderProperty

    Permalink
  34. trait ParamsOnlyCommand extends TypeConverterFactories with Command

    Permalink
  35. trait ParamsOnlyCommandSupport extends CommandSupport

    Permalink
  36. trait TypeConverterFactories extends BindingImplicits

    Permalink
  37. trait TypeConverterFactory[T] extends BindingImplicits

    Permalink
  38. class ValidatedBoundFieldDescriptor[S, T] extends ValidatedFieldDescriptor[S, T]

    Permalink
  39. trait ValidatedFieldDescriptor[S, T] extends DataboundFieldDescriptor[S, T]

    Permalink
  40. type Validator[T] = (FieldValidation[T]) ⇒ FieldValidation[T]

    Permalink
  41. trait CommandHandler extends AnyRef

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.1) This approach is not fully type-safe. The compiler can't enforce that the handle method returns a S. Please use the >> or apply method on a command.

  42. abstract class ModelCommand[T] extends Command

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.1) This was meant for usage with the org.scalatra.commands.CommandHandler, but that approach is not fully compiler verified. Look at using the execute method on a command instead.

Inherited from AnyRef

Inherited from Any

Ungrouped