Package VASSAL.tools.opcache

Interface Op<V>

All Known Subinterfaces:
CropOp, GamePieceOp, ImageOp, RotateOp, RotateScaleOp, ScaleOp, SourceOp, SVGOp
All Known Implementing Classes:
AbstractOpImpl, AbstractOpImpl, AbstractTiledOpImpl, AbstractTileOpImpl, CropOpBitmapImpl, GamePieceOpImpl, GridOp, ImageItem.BaseOp, ImageSourceOpBitmapImpl, Labeler.HTMLLabelOp, Labeler.LabelOp, OrthoRotateOpBitmapImpl, RotateScaleOpBitmapImpl, RotateScaleOpSVGImpl, ScaleOpBitmapImpl, ScaleOpTiledBitmapImpl, SolidColorOp, SourceOpBitmapImpl, SourceOpDiskCacheBitmapImpl, SourceOpSVGImpl, SourceOpTiledBitmapImpl, SourceTileOpBitmapImpl, SourceTileOpSVGImpl
public interface Op<V>
An operation with a cacheable result.
Since:
3.1.0
Author:
Joel Uckelman

  • Method Summary

    Modifier and Type
    Method
    Description
    V
    eval()
    Runs the Op.
    List<Op<?>>
    getSources()
    Returns a list of Ops on which this Op depends.
    OpCache.Key<V>
    newKey()
    Returns the current cache key for this Op.
    void
    update()
    Invalidates the current cache key for this Op.

  • Method Details

    • eval

      V eval() throws Exception
      Runs the Op. This method should be called only by the caching framework.
      Returns:
      the result of running this Op
      Throws:
      Exception

    • getSources

      List<Op<?>> getSources()
      Returns a list of Ops on which this Op depends.
      Returns:
      the Ops on which this Op depends

    • newKey

      OpCache.Key<V> newKey()
      Returns the current cache key for this Op.
      Returns:
      the current cache key for this Op

    • update

      void update()
      Invalidates the current cache key for this Op.