Document (org.macroing.cel4j.java.binary API)

java.lang.Object
- org.macroing.cel4j.java.binary.util.Document

```
public final class Document
extends java.lang.Object
```
A class that encapsulates a document that can be written to.
One of the main goals with this class, is to create Strings containing well-formatted text, that can subsequently be written to disk etc.
To write a Hello World program in Java, consider the following example:
```
 Document document = new Document();
 document.line("public class HelloWorld {", Indentation.INDENT);
 document.line("public static void main(String[] args) {", Indentation.INDENT);
 document.line("System.out.println(\"Hello, World!\");", Indentation.OUTDENT);
 document.line("}", Indentation.OUTDENT);
 document.line("}");
 
 System.out.print(document);
 
```
This class is thread-safe and thus suitable for concurrent use without external synchronization. Although, calling any of the methods, with the exception for toString(), from multiple Threads at the same time, may produce unexpected results.
Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Document.Indentation` An `Indentation` is used by some methods in a `Document` instance to perform optional indent and outdent operations.

Constructor Summary

Constructors
Constructor and Description

Document()
Constructs a new Document instance.

Constructors
Constructor and Description
`Document()` Constructs a new `Document` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document`	`indent()` Performs an indentation operation on this `Document` instance.
`Document`	`line()` Appends an empty line of text to this `Document` instance.
`Document`	`line(Document.Indentation indentation)` Appends an empty line of text to this `Document` instance.
`Document`	`line(java.lang.String textAfterIndentation)` Appends a line of text to this `Document` instance.
`Document`	`line(java.lang.String textAfterIndentation, Document.Indentation indentation)` Appends a line of text to this `Document` instance.
`Document`	`line(java.lang.String textAfterIndentation, java.lang.String textBeforeIndentation)` Appends a line of text to this `Document` instance.
`Document`	`line(java.lang.String textAfterIndentation, java.lang.String textBeforeIndentation, Document.Indentation indentation)` Appends a line of text to this `Document` instance.
`Document`	`linef(java.lang.String textAfterIndentationFormat, java.lang.Object... objects)` Appends a line of text to this `Document` instance.
`Document`	`outdent()` Performs an outdentation operation on this `Document` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `Document` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Document
```
public Document()
```
    Constructs a new Document instance.
- Method Detail
  - indent
```
public Document indent()
```
    Performs an indentation operation on this Document instance.
    Returns the Document itself, such that method chaining is possible.
    
    Returns:
    
    the Document itself, such that method chaining is possible
  - line
```
public Document line()
```
    Appends an empty line of text to this Document instance.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    Calling this method is equivalent to calling line("").
    Returns the Document itself, such that method chaining is possible.
    
    Returns:
    
    the Document itself, such that method chaining is possible
  - line
```
public Document line(Document.Indentation indentation)
```
    Appends an empty line of text to this Document instance.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    Calling this method is equivalent to calling line("", indentation).
    Returns the Document itself, such that method chaining is possible.
    If indentation is null, a NullPointerException will be thrown.
    
    Parameters:
    
    indentation - the indentation operation to be used at the end
    
    Returns:
    
    the Document itself, such that method chaining is possible
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, indentation is null
  - line
```
public Document line(java.lang.String textAfterIndentation)
```
    Appends a line of text to this Document instance.
    The line of text consists of textAfterIndentation, which is appended after the indentation of the given line.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    Calling this method is equivalent to calling line(textAfterIndentation, "").
    Returns the Document itself, such that method chaining is possible.
    If textAfterIndentation is null, a NullPointerException will be thrown.
    
    Parameters:
    
    textAfterIndentation - the text to append after the indentation
    
    Returns:
    
    the Document itself, such that method chaining is possible
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, textAfterIndentation is null
  - line
```
public Document line(java.lang.String textAfterIndentation,
                     Document.Indentation indentation)
```
    Appends a line of text to this Document instance.
    The line of text consists of textAfterIndentation, which is appended after the indentation of the given line.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    Calling this method is equivalent to calling line(textAfterIndentation, "", indentation).
    Returns the Document itself, such that method chaining is possible.
    If either textAfterIndentation or indentation are null, a NullPointerException will be thrown.
    
    Parameters:
    
    textAfterIndentation - the text to append after the indentation
    
    indentation - the indentation operation to be used at the end
    
    Returns:
    
    the Document itself, such that method chaining is possible
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either textAfterIndentation or indentation are null
  - line
```
public Document line(java.lang.String textAfterIndentation,
                     java.lang.String textBeforeIndentation)
```
    Appends a line of text to this Document instance.
    The line of text consists of three parts. The first part comes from textBeforeIndentation. The second part is the indentation itself, if any. The third part comes from textAfterIndentation.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    Calling this method is equivalent to calling line(textAfterIndentation, textBeforeIndentation, Indentation.SKIP).
    Returns the Document itself, such that method chaining is possible.
    If either textAfterIndentation or textBeforeIndentation are null, a NullPointerException will be thrown.
    
    Parameters:
    
    textAfterIndentation - the text to append after the indentation
    
    textBeforeIndentation - the text to prepend before the indentation
    
    Returns:
    
    the Document itself, such that method chaining is possible
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either textAfterIndentation or textBeforeIndentation are null
  - line
```
public Document line(java.lang.String textAfterIndentation,
                     java.lang.String textBeforeIndentation,
                     Document.Indentation indentation)
```
    Appends a line of text to this Document instance.
    The line of text consists of three parts. The first part comes from textBeforeIndentation. The second part is the indentation itself, if any. The third part comes from textAfterIndentation.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    The parameter indentation is used to perform an optional indent- or outdent operation at the end. To perform an indent operation, use Indentation.INDENT. To perform an outdent operation, use Indentation.OUTDENT. To perform no indent- or outdent operation, use Indentation.SKIP.
    Returns the Document itself, such that method chaining is possible.
    If either textAfterIndentation, textBeforeIndentation or indentation are null, a NullPointerException will be thrown.
    
    Parameters:
    
    textAfterIndentation - the text to append after the indentation
    
    textBeforeIndentation - the text to prepend before the indentation
    
    indentation - the indentation operation to be used at the end
    
    Returns:
    
    the Document itself, such that method chaining is possible
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either textAfterIndentation, textBeforeIndentation or indentation are null
  - linef
```
public Document linef(java.lang.String textAfterIndentationFormat,
                      java.lang.Object... objects)
```
    Appends a line of text to this Document instance.
    The line of text consists of String.format(textAfterIndentationFormat, objects), which is appended after the indentation of the given line.
    If either textAfterIndentation or textBeforeIndentation contains one or more line separators, they will be split into multiple lines of text. The one of the two with most line separators will decide how many lines to create. If one of the two has less line separators than the other, an empty String literal will be used where no corresponding text can be found.
    Calling this method is equivalent to calling line(String.format(textAfterIndentationFormat, objects)), with the exception that null references are not allowed.
    Returns the Document itself, such that method chaining is possible.
    If either textAfterIndentationFormat or objects are null, a NullPointerException will be thrown.
    
    Parameters:
    
    textAfterIndentationFormat - a format String for the text to append after the indentation
    
    objects - an array of Objects to use in the format String
    
    Returns:
    
    the Document itself, such that method chaining is possible
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either textAfterIndentationFormat or objects are null
  - outdent
```
public Document outdent()
```
    Performs an outdentation operation on this Document instance.
    Returns the Document itself, such that method chaining is possible.
    
    Returns:
    
    the Document itself, such that method chaining is possible
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Document instance.
    The String representation is the text that you appended to it with all lines and indentations etc.
    This method and the String returned are both part of the contract for this class and will not change.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Document instance

Class Document

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Method Detail

indent

line

line

line

line

line

line

linef

outdent

toString