Class SummarizerListMultiline<T>

Object
AnchorBean<Summarizer<T>>
Summarizer<T>
SummarizerListMultiline<T>
Type Parameters:
T - type of entity to summarize (its string representation is taken)

public class SummarizerListMultiline<T> extends Summarizer<T>
Creates a string where each line is an element.

The string representation for each element is printed as a line.

Author:
Owen Feehan
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(T element)
    Adds a element to the summary.
    A string summarizing this item.
    boolean
    Whether a ImageMetadataInput is required as an input.

    Methods inherited from class org.anchoranalysis.plugin.io.bean.summarizer.Summarizer

    addAll

    Methods inherited from class org.anchoranalysis.bean.AnchorBean

    checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • SummarizerListMultiline

      public SummarizerListMultiline()
  • Method Details

    • add

      public void add(T element) throws OperationFailedException
      Description copied from class: Summarizer
      Adds a element to the summary.
      Specified by:
      add in class Summarizer<T>
      Parameters:
      element - the element to add.
      Throws:
      OperationFailedException
    • describe

      public String describe() throws OperationFailedException
      Description copied from class: Summarizer
      A string summarizing this item.
      Specified by:
      describe in class Summarizer<T>
      Returns:
      the description.
      Throws:
      OperationFailedException
    • requiresImageMetadata

      public boolean requiresImageMetadata()
      Description copied from class: Summarizer
      Whether a ImageMetadataInput is required as an input.
      Specified by:
      requiresImageMetadata in class Summarizer<T>
      Returns:
      true if the summarize requires ImageMetadataInput as input, or false if any input is acceptable.