Package com.palantir.javaformat.doc

Class Break

java.lang.Object
com.palantir.javaformat.doc.HasUniqueId
com.palantir.javaformat.doc.Doc
com.palantir.javaformat.doc.Break
All Implemented Interfaces:
Op
@Immutable @Immutable public abstract class Break extends Doc implements Op
A leaf node in a Doc for an optional break.

  • Constructor Details

    • Break

      public Break()

  • Method Details

    • fillMode

      public abstract FillMode fillMode()

    • flat

      public abstract String flat()

    • plusIndent

      public abstract Indent plusIndent()

    • optTag

      public abstract Optional<BreakTag> optTag()

    • hasColumnLimit

      public abstract boolean hasColumnLimit()
      If this break is restricted by its parent Level's Level.getColumnLimitBeforeLastBreak().

    • make

      public static Break make(FillMode fillMode, String flat, Indent plusIndent)
      Make a Break.
      Parameters:
      fillMode - the FillMode
      flat - the text when not broken
      plusIndent - extra indent if taken
      Returns:
      the new Break

    • make

      public static Break make(FillMode fillMode, String flat, Indent plusIndent, Optional<BreakTag> optTag)
      Make a Break.
      Parameters:
      fillMode - the FillMode
      flat - the text when not broken
      plusIndent - extra indent if taken
      optTag - an optional tag for remembering whether the break was taken
      Returns:
      the new Break

    • makeForced

      public static Break makeForced()
      Make a forced Break.
      Returns:
      the new forced Break

    • evalPlusIndent

      public int evalPlusIndent(State state)
      Return the Break's extra indent.
      Returns:
      the extra indent

    • isForced

      public boolean isForced()
      Is the Break forced?
      Returns:
      whether the Break is forced

    • add

      public void add(DocBuilder builder)
      Description copied from interface: Op
      Add an Op to a DocBuilder.
      Specified by:
      add in interface Op
      Parameters:
      builder - the DocBuilder

    • computeWidth

      protected float computeWidth()
      Description copied from class: Doc
      Compute the Doc's width.
      Specified by:
      computeWidth in class Doc
      Returns:
      the width, or Float.POSITIVE_INFINITY if it must be broken

    • computeFlat

      protected String computeFlat()
      Description copied from class: Doc
      Compute the Doc's flat value. Not defined (and never called) if contains forced breaks.
      Specified by:
      computeFlat in class Doc
      Returns:
      the flat value

    • computeRange

      protected com.google.common.collect.Range<Integer> computeRange()
      Description copied from class: Doc
      Compute the Doc's Range of Input.Tokens.
      Specified by:
      computeRange in class Doc
      Returns:
      the Range

    • computeBreaks

      public State computeBreaks(State stateIn, boolean broken)

    • computeBreaks

      public State computeBreaks(CommentsHelper commentsHelper, int maxWidth, State state, Obs.ExplorationNode observationNode)
      Description copied from class: Doc
      Make breaking decisions for a Doc.
      Specified by:
      computeBreaks in class Doc
      maxWidth - the maximum line width
      state - the current output state
      Returns:
      the new output state

    • write

      public void write(State state, Output output)
      Description copied from class: Doc
      Write a Doc to an Output, after breaking decisions have been made.
      Specified by:
      write in class Doc

    • builder

      public static Break.Builder builder()