com.perforce.p4java.option.server
Class MatchingLinesOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.server.MatchingLinesOptions

public class MatchingLinesOptions
extends Options

Options objects for the IOptionsServer getMatchingLines command. Note that not all "p4 grep" options are currently implemented or recognised; see the comments below for a list of recognised and non-recognised options and their semantics.

 Recognised options: -a -i -n -v -A  -B  -C  -t -F -G

    The -a flag searches all revisions within the specific range, rather
        than just the highest revision in the range.

        The -i flag causes the pattern matching to be case insensitive, by
        default matching is case sensitive.

        The -n flag displays the matching line number after the file revision
        number,  by default output of matched files consist of the revision
        and the matched line separated by a colon ':'.

        The -v flag displays files with non-matching lines.

        The -F flag is used to interpret the pattern as a fixed string.

        The -G flag is used to interpret the pattern as a regular expression,
        the default behavior.

        The -t flag instructs grep to treat binary files as text.  By default
        only files of type text are selected for pattern matching.

        The -A  flag displays num lines of trailing context after
        matching lines.

        The -B  flag displays num lines of leading context before
        matching lines.

        The -C  flag displays num lines of output context.

   Currently non-recognised options: -s, -l, -L

        The -s flag suppresses error messages that result from abandoning
        files that have a maximum number of characters in a single line that
        are greater than 4096.  By default grep will abandon these files and
        report an error.

        The -L flag changes the output to display the name of each selected
        file from which no output would normally have been displayed. The
        scanning will stop on the first match.

        The -l flag changes the output to display the name of each selected
        file from which output would normally have been displayed. The
        scanning will stop on the first match.
        

See Also:

com.perforce.p4java.server.IOptionsServer#getMatchingLines(java.util.List, java.lang.String, com.perforce.p4java.core.file.GetMatchingLinesOptions)

Field Summary

protected boolean	allRevisions Corresponds to the p4 grep "-a" option
protected boolean	caseInsensitive Corresponds to the p4 grep -i option
protected boolean	fixedPattern Corresponds to the p4 grep -F and -G options: if true, corresponds to -F; if false, to -G
protected boolean	includeLineNumbers Corresponds to the p4 grep -n option
protected int	leadingContext Corresponds to the p4 grep -B option; if zero, option is off
protected boolean	nonMatchingLines Corresponds to the p4 grep -v option
static String	OPTIONS_SPECS
protected int	outputContext Corresponds to the p4 grep -C option; if zero, option is off
protected boolean	searchBinaries Corresponds to the p4 grep -t option
protected int	trailingContext Corresponds to the p4 grep -A option; if zero, option is off

Fields inherited from class com.perforce.p4java.option.Options

immutable, optionList, OPTPFX

Constructor Summary

MatchingLinesOptions()
Default constructor; sets all fields to zero, null, or false as appropriate.

MatchingLinesOptions(boolean allRevisions, boolean caseInsensitive, boolean includeLineNumbers, boolean nonMatchingLines, boolean searchBinaries, int outputContext, int trailingContext, int leadingContext, boolean fixedPattern)
Explicit value constructor.

MatchingLinesOptions(String... options)
String-based constructor.

Method Summary

int	getLeadingContext()
int	getOutputContext()
int	getTrailingContext()
boolean	isAllRevisions()
boolean	isCaseInsensitive()
boolean	isFixedPattern()
boolean	isIncludeLineNumbers()
boolean	isNonMatchingLines()
boolean	isSearchBinaries()
List<String>	processOptions(IServer server) Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command.
MatchingLinesOptions	setAllRevisions(boolean allRevisions)
MatchingLinesOptions	setCaseInsensitive(boolean caseInsensitive)
MatchingLinesOptions	setFixedPattern(boolean fixedPattern)
MatchingLinesOptions	setIncludeLineNumbers(boolean includeLineNumbers)
MatchingLinesOptions	setLeadingContext(int leadingContext)
MatchingLinesOptions	setNonMatchingLines(boolean nonMatchingLines)
MatchingLinesOptions	setOutputContext(int outputContext)
MatchingLinesOptions	setSearchBinaries(boolean searchBinaries)
MatchingLinesOptions	setTrailingContext(int trailingContext)

Methods inherited from class com.perforce.p4java.option.Options

applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions

Methods inherited from class java.lang.Object

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

Field Detail

OPTIONS_SPECS

public static final String OPTIONS_SPECS

See Also:

Constant Field Values

allRevisions

protected boolean allRevisions

Corresponds to the p4 grep "-a" option

caseInsensitive

protected boolean caseInsensitive

Corresponds to the p4 grep -i option

includeLineNumbers

protected boolean includeLineNumbers

Corresponds to the p4 grep -n option

nonMatchingLines

protected boolean nonMatchingLines

Corresponds to the p4 grep -v option

searchBinaries

protected boolean searchBinaries

Corresponds to the p4 grep -t option

outputContext

protected int outputContext

Corresponds to the p4 grep -C option; if zero, option is off

trailingContext

protected int trailingContext

Corresponds to the p4 grep -A option; if zero, option is off

leadingContext

protected int leadingContext

Corresponds to the p4 grep -B option; if zero, option is off

fixedPattern

protected boolean fixedPattern

Corresponds to the p4 grep -F and -G options: if true, corresponds to -F; if false, to -G

Constructor Detail

MatchingLinesOptions

public MatchingLinesOptions()

Default constructor; sets all fields to zero, null, or false as appropriate.

MatchingLinesOptions

public MatchingLinesOptions(boolean allRevisions,
                            boolean caseInsensitive,
                            boolean includeLineNumbers,
                            boolean nonMatchingLines,
                            boolean searchBinaries,
                            int outputContext,
                            int trailingContext,
                            int leadingContext,
                            boolean fixedPattern)

Explicit value constructor.

MatchingLinesOptions

public MatchingLinesOptions(String... options)

String-based constructor.

Parameters:

options - options strings.

Method Detail

processOptions

public List<String> processOptions(IServer server)
                            throws OptionsException

Description copied from class: Options

Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

Specified by:

processOptions in class Options

Parameters:

server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...

Returns:

non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.

Throws:

OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.

See Also:

Options.processOptions(com.perforce.p4java.server.IServer)

isAllRevisions

public boolean isAllRevisions()

setAllRevisions

public MatchingLinesOptions setAllRevisions(boolean allRevisions)

isCaseInsensitive

public boolean isCaseInsensitive()

setCaseInsensitive

public MatchingLinesOptions setCaseInsensitive(boolean caseInsensitive)

isIncludeLineNumbers

public boolean isIncludeLineNumbers()

setIncludeLineNumbers

public MatchingLinesOptions setIncludeLineNumbers(boolean includeLineNumbers)

isNonMatchingLines

public boolean isNonMatchingLines()

setNonMatchingLines

public MatchingLinesOptions setNonMatchingLines(boolean nonMatchingLines)

isSearchBinaries

public boolean isSearchBinaries()

setSearchBinaries

public MatchingLinesOptions setSearchBinaries(boolean searchBinaries)

getOutputContext

public int getOutputContext()

setOutputContext

public MatchingLinesOptions setOutputContext(int outputContext)

getTrailingContext

public int getTrailingContext()

setTrailingContext

public MatchingLinesOptions setTrailingContext(int trailingContext)

getLeadingContext

public int getLeadingContext()

setLeadingContext

public MatchingLinesOptions setLeadingContext(int leadingContext)

isFixedPattern

public boolean isFixedPattern()

setFixedPattern

public MatchingLinesOptions setFixedPattern(boolean fixedPattern)