org.sfj

Class StringsCompare

java.lang.Object

org.sfj.StringsCompare

public class StringsCompare
extends Object

Compare two string sequences (files, resource streams, anything that can be expressed as sequence of lines). Possibly ignore line endings, possible ignore leading and/or trailing whitespace, possibly ignore case.

Useful for testing when you have an expected file as a resource, say, and need to compare it to output of some execution.

Field Summary

Fields

Modifier and Type	Field and Description
static Function<String,String>	DEFAULT_OPERATION Default operation is to remove trailing whitespace before compare.
static Function<String,String>	IDENT Ident transform, use when you want no mapping done on strings.
static Function<String,String>	LOWER_CASE Mapping transform to lowercase a string, allowing for case insensitive compares.
static Predicate<String>	SKIP_BLANK Predicate to skip whitespace only lines.
static Predicate<String>	SKIP_EMPTY Predicate to skip empty lines.
static Predicate<String>	SKIP_NONE Predicate to skip no lines.
static Function<String,String>	TRIM_LEADING_AND_TRAILING_WHITESPACE Mapping transform to trim leading and trailing whitespace.
static Function<String,String>	TRIM_LEADING_WHITESPACE Mapping transform to remove leading whitespace.
static Function<String,String>	TRIM_TRAILING_WHITESPACE Mapping transform to remove trailing whitespace.

Method Summary

Modifier and Type	Method and Description
static org.sfj.StringsCompare.LineSource	source(Class<?> clz, String name) Source from a resource stream, UTF-8 charset.
static org.sfj.StringsCompare.LineSource	source(Class<?> clz, String name, Charset cset) Source from a resource stream, specified charset
static org.sfj.StringsCompare.LineSource	source(File f) Source from a file using UTF8 charset encoding.
static org.sfj.StringsCompare.LineSource	source(File f, Charset cSet) Source from a file using specified encoding.
static org.sfj.StringsCompare.LineSource	source(InputStream is) Source from an input stream, using UTF-8 encoding.
static org.sfj.StringsCompare.LineSource	source(InputStream is, Charset cset) Source from an input stream using a specific char set.
static org.sfj.StringsCompare.LineSource	source(Iterable<String> iter) Source from an iterable.
static org.sfj.StringsCompare.LineSource	source(Iterator<String> iter) Source from an arbitrary iterator.
static org.sfj.StringsCompare.LineSource	source(Reader r) Source for a reader.
static org.sfj.StringsCompare.LineSource	source(String s) Source from a string.
static org.sfj.StringsCompare.LineSource	source(String[] arr) Source from an array of strings.
static org.sfj.StringsCompare.LineSource	source(String[] arr, int pos, int len) Source from an array of strings.
static boolean	stringsCompare(org.sfj.StringsCompare.LineSource left, org.sfj.StringsCompare.LineSource right) Compare two LineSource objects using the default operation.
static boolean	stringsCompare(org.sfj.StringsCompare.LineSource left, org.sfj.StringsCompare.LineSource right, Function<String,String> mapper) Compare with no skipping filter but the specified mapper.
static boolean	stringsCompare(org.sfj.StringsCompare.LineSource left, org.sfj.StringsCompare.LineSource right, Predicate<String> filter) Compare with a specified skipping predicate and the default mapping.
static boolean	stringsCompare(org.sfj.StringsCompare.LineSource left, org.sfj.StringsCompare.LineSource right, Predicate<String> filter, Function<String,String> mapper) Compare two LineSource objects using a specified operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SKIP_NONE

public static Predicate<String> SKIP_NONE

Predicate to skip no lines.

SKIP_BLANK

public static Predicate<String> SKIP_BLANK

Predicate to skip whitespace only lines.

SKIP_EMPTY

public static Predicate<String> SKIP_EMPTY

Predicate to skip empty lines.

IDENT

public static final Function<String,String> IDENT

Ident transform, use when you want no mapping done on strings.

TRIM_LEADING_WHITESPACE

public static final Function<String,String> TRIM_LEADING_WHITESPACE

Mapping transform to remove leading whitespace.

TRIM_TRAILING_WHITESPACE

public static final Function<String,String> TRIM_TRAILING_WHITESPACE

Mapping transform to remove trailing whitespace.

LOWER_CASE

public static final Function<String,String> LOWER_CASE

Mapping transform to lowercase a string, allowing for case insensitive compares.

TRIM_LEADING_AND_TRAILING_WHITESPACE

public static final Function<String,String> TRIM_LEADING_AND_TRAILING_WHITESPACE

Mapping transform to trim leading and trailing whitespace.

DEFAULT_OPERATION

public static final Function<String,String> DEFAULT_OPERATION

Default operation is to remove trailing whitespace before compare.

Method Detail

stringsCompare

public static boolean stringsCompare(org.sfj.StringsCompare.LineSource left,
                                     org.sfj.StringsCompare.LineSource right)
                              throws IOException

Compare two LineSource objects using the default operation.

Parameters:

left - one side.

right - the other.

Returns:

true if they match

Throws:

IOException - on exception

stringsCompare

public static boolean stringsCompare(org.sfj.StringsCompare.LineSource left,
                                     org.sfj.StringsCompare.LineSource right,
                                     Predicate<String> filter)
                              throws IOException

Compare with a specified skipping predicate and the default mapping.

Parameters:

left - left source

right - right source.

filter - filter to use to skip lines

Returns:

true if they match

Throws:

IOException - on exception

stringsCompare

public static boolean stringsCompare(org.sfj.StringsCompare.LineSource left,
                                     org.sfj.StringsCompare.LineSource right,
                                     Function<String,String> mapper)
                              throws IOException

Compare with no skipping filter but the specified mapper.

Parameters:

left - left source

right - right source

mapper - mapper per line.

Returns:

true if the sources match

Throws:

IOException - on exception

stringsCompare

public static boolean stringsCompare(org.sfj.StringsCompare.LineSource left,
                                     org.sfj.StringsCompare.LineSource right,
                                     Predicate<String> filter,
                                     Function<String,String> mapper)
                              throws IOException

Compare two LineSource objects using a specified operation. Note that any Function operation can be changed to make compound operations.

Parameters:

left - left source

right - right source

filter - predicate to designate lines to skip

mapper - mapper per line.

Returns:

true if they match

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(Reader r)
                                                throws IOException

Source for a reader.

Parameters:

r - reader to draw from

Returns:

LineSource

Throws:

IOException - on underlying exception

source

public static org.sfj.StringsCompare.LineSource source(String s)
                                                throws IOException

Source from a string.

Parameters:

s - String to use

Returns:

LineSource

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(InputStream is)
                                                throws IOException

Source from an input stream, using UTF-8 encoding.

Parameters:

is - input stream

Returns:

LineSource

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(InputStream is,
                                                       Charset cset)
                                                throws IOException

Source from an input stream using a specific char set.

Parameters:

is - input stream

cset - charset encoding

Returns:

LineSource

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(Class<?> clz,
                                                       String name)
                                                throws IOException

Source from a resource stream, UTF-8 charset.

Parameters:

clz - class to use for getResourceAsStream()

name - name to open

Returns:

LineSource

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(Class<?> clz,
                                                       String name,
                                                       Charset cset)
                                                throws IOException

Source from a resource stream, specified charset

Parameters:

clz - class to use

name - name to use for resource

cset - charset encoding to use.

Returns:

LineSource

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(String[] arr)

Source from an array of strings.

Parameters:

arr - array of strings

Returns:

LineSource

source

public static org.sfj.StringsCompare.LineSource source(String[] arr,
                                                       int pos,
                                                       int len)

Source from an array of strings.

Parameters:

arr - array of strings

pos - position of first entry to use

len - number of entries to use

Returns:

LineSource

source

public static org.sfj.StringsCompare.LineSource source(Iterator<String> iter)

Source from an arbitrary iterator.

Parameters:

iter - base iterator

Returns:

LineSource

source

public static org.sfj.StringsCompare.LineSource source(Iterable<String> iter)

Source from an iterable. What did you expect, exactly?

Parameters:

iter - iterable

Returns:

LineSource

source

public static org.sfj.StringsCompare.LineSource source(File f)
                                                throws IOException

Source from a file using UTF8 charset encoding.

Parameters:

f - file to open

Returns:

LineSource

Throws:

IOException - on exception

source

public static org.sfj.StringsCompare.LineSource source(File f,
                                                       Charset cSet)
                                                throws IOException

Source from a file using specified encoding.

Parameters:

f - file

cSet - charset

Returns:

LineSource

Throws:

IOException - on exception