Eclipse ORB Primitive Function Library 5.1.1 · org.glassfish.pfl.basic.tools.file.Block

Modifier and Type	Field and Description
private List<String>	data
private final Set<String>	tags

Access	Constructor and Description
private	Block(final List<String> data, final Set<String> tags)
public	Block(final List<String> data) Create a new Block from a list of strings.
public	Block(final Block block) Create a new Block which is a copy of block.

Method Summary

Modifier and Type	Method and Description
public void	addAfterLast(final String str) Add String after the end of the block.
public void	addBeforeFirst(final String str) Add String before the start of the block.
public void	addPrefixToAll(String prefix) Add the prefix to each string in the block.
public void	addTag(final String tag) Add a tag to the block.
public List<String>	contents() Get the contents of the block.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private String	expandTabs(String src)
public Block	expandTabs() Replace tabs with spaces, assuming tab stops are located as usual at n*8 + 1
public String	find(final String search) Return the first string in the block that contains the search string.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasTag(final String tag) Return whether or not a block has a particular tag.
public boolean	hasTags(final String... tags) Return whether or not a block has ALL of the listed tags.
public Block	instantiateTemplate(Map<String, String> parameters) replace all occurrences of @KEY@ with parameters.get( KEY ).
public Pair<Block, Block>	splitFirst() Split block into two blocks, with only the first line of the original Block in result.first().
public Block	substitute(List<? extends Pair<String, String>> substitutions)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	write(final FileWrapper fw) Write block to FileWrapper.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

data	back to summary
private List<String> data

tags	back to summary
private final Set<String> tags

Block	back to summary
private Block(final List<String> data, final Set<String> tags)

Block	back to summary
public Block(final List<String> data) Create a new Block from a list of strings.

Block	back to summary
public Block(final Block block) Create a new Block which is a copy of block.

Method Detail

addAfterLast	back to summary
public void addAfterLast(final String str) Add String after the end of the block.

addBeforeFirst	back to summary
public void addBeforeFirst(final String str) Add String before the start of the block.

addPrefixToAll	back to summary
public void addPrefixToAll(String prefix) Add the prefix to each string in the block.

addTag	back to summary
public void addTag(final String tag) Add a tag to the block. Useful for classifying blocks.

contents	back to summary
public List<String> contents() Get the contents of the block.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

expandTabs	back to summary
private String expandTabs(String src)

expandTabs	back to summary
public Block expandTabs() Replace tabs with spaces, assuming tab stops are located as usual at n*8 + 1

find	back to summary
public String find(final String search) Return the first string in the block that contains the search string.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

hasTag	back to summary
public boolean hasTag(final String tag) Return whether or not a block has a particular tag.

hasTags	back to summary
public boolean hasTags(final String... tags) Return whether or not a block has ALL of the listed tags.

instantiateTemplate	back to summary
public Block instantiateTemplate(Map<String, String> parameters) replace all occurrences of @KEY@ with parameters.get( KEY ). This is very simple: only one scan is made, so @...@ patterns in the parameters values are ignored.

splitFirst	back to summary
public Pair<Block, Block> splitFirst() Split block into two blocks, with only the first line of the original Block in result.first().

substitute	back to summary
public Block substitute(List<? extends Pair<String, String>> substitutions)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

write	back to summary
public void write(final FileWrapper fw) throws IOException Write block to FileWrapper. FileWrapper must be open for writing.

public Class Block

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail