summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java
diff options
context:
space:
mode:
Diffstat (limited to 'base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java')
-rw-r--r--base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java81
1 files changed, 31 insertions, 50 deletions
diff --git a/base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java b/base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java
index 615af85..16d50c0 100644
--- a/base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java
+++ b/base/src/main/java/bjc/utils/ioutils/blocks/BlockReaders.java
@@ -1,81 +1,62 @@
package bjc.utils.ioutils.blocks;
-import java.io.Reader;
+import java.io.*;
-/**
- * Utility methods for constructing instances of {@link BlockReader}
+/** Utility methods for constructing instances of {@link BlockReader}
*
- * @author bjculkin
- *
- */
+ * @author bjculkin */
public class BlockReaders {
- /**
- * Create a new simple block reader that works off a regex.
- *
- * @param blockDelim
- * The regex that separates blocks.
+ /** Create a new simple block reader that works off a regex.
*
- * @param source
- * The reader to get blocks from.
+ * @param blockDelim The regex that separates blocks.
+ * @param source The reader to get blocks from.
*
- * @return A configured simple reader.
- */
- public static SimpleBlockReader simple(final String blockDelim, final Reader source) {
+ * @return A configured simple reader. */
+ public static SimpleBlockReader simple(
+ final String blockDelim, final Reader source)
+ {
return new SimpleBlockReader(blockDelim, source);
}
- /**
- * Create a new pushback block reader.
+ /** Create a new pushback block reader.
*
- * @param src
- * The block reader to read blocks from.
+ * @param src The block reader to read blocks from.
*
- * @return A configured pushback reader.
- */
+ * @return A configured pushback reader. */
public static PushbackBlockReader pushback(final BlockReader src) {
return new PushbackBlockReader(src);
}
- /**
- * Create a new triggered block reader.
+ /** Create a new triggered block reader.
*
- * @param source
- * The block reader to read blocks from.
+ * @param source The block reader to read blocks from.
+ * @param action The action to execute before reading a block.
*
- * @param action
- * The action to execute before reading a block.
- *
- * @return A configured triggered block reader.
- */
- public static BlockReader trigger(final BlockReader source, final Runnable action) {
+ * @return A configured triggered block reader. */
+ public static BlockReader trigger(
+ final BlockReader source, final Runnable action)
+ {
return new TriggeredBlockReader(source, action);
}
- /**
- * Create a new layered block reader.
- *
- * @param primary
- * The first source to read blocks from.
+ /** Create a new layered block reader.
*
- * @param secondary
- * The second source to read blocks from.
+ * @param primary The first source to read blocks from.
+ * @param secondary The second source to read blocks from.
*
- * @return A configured layered block reader.
- */
- public static BlockReader layered(final BlockReader primary,
- final BlockReader secondary) {
+ * @return A configured layered block reader. */
+ public static BlockReader layered(
+ final BlockReader primary, final BlockReader secondary)
+ {
return new LayeredBlockReader(primary, secondary);
}
- /**
- * Create a new serial block reader.
+ /** Create a new serial block reader.
*
- * @param readers
- * The readers to pull from, in the order to pull from them.
+ * @param readers The readers to pull from, in the order to pull from them.
*
- * @return A configured serial block reader.
- */
+ * @return A configured serial block reader. */
public static BlockReader serial(final BlockReader... readers) {
return new SerialBlockReader(readers);
}
-} \ No newline at end of file
+}