Class SkipPipe

All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

Skip a number of bytes or characters from the input message.
Author:
Jaco de Groot (***@dynasol.nl)
  • Constructor Details

    • SkipPipe

      public SkipPipe()
  • Method Details

    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Throws:
      PipeRunException
    • setSkip

      public void setSkip(int skip)
      Number of bytes (for binary input) or characters (for character input) to skip. An empty byte array or string is returned when skip is larger than the length of the input.
      Default value
      0
    • setLength

      public void setLength(int length)
      If length>=0 only these number of bytes (for binary input) or characters (for character input) is returned.
      Default value
      -1