Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.client
Class UnlockFilesOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.client.UnlockFilesOptions

public class UnlockFilesOptions
extends Options

Options class for IClient.unlockFiles.

See Also:
IClient.unlockFiles(java.util.List, com.perforce.p4java.option.client.UnlockFilesOptions)

Field Summary
protected  int changelistId
          If positive, use the changelistId given instead of the default changelist.
protected  boolean forceUnlock
          If true, enables you to unlock files in changelists owned by other users.
static String OPTIONS_SPECS
          Options: -c[changelist], -f
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
UnlockFilesOptions()
          Default constructor.
UnlockFilesOptions(int changelistId, boolean forceUnlock)
          Explicit-value constructor.
UnlockFilesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getChangelistId()
           
 boolean isForceUnlock()
           
 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.
 UnlockFilesOptions setChangelistId(int changelistId)
           
 UnlockFilesOptions setForceUnlock(boolean forceUnlock)
           
 
Methods inherited from class com.perforce.p4java.option.Options
applyRule, 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
Options: -c[changelist], -f

See Also:
Constant Field Values

changelistId

protected int changelistId
If positive, use the changelistId given instead of the default changelist. Corresponds to the -c option.

forceUnlock

protected boolean forceUnlock
If true, enables you to unlock files in changelists owned by other users. Corresponds to the -f option.

Constructor Detail

UnlockFilesOptions

public UnlockFilesOptions()
Default constructor.

UnlockFilesOptions

public UnlockFilesOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.

WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).

NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.

See Also:
Options.Options(java.lang.String...)

UnlockFilesOptions

public UnlockFilesOptions(int changelistId,
                          boolean forceUnlock)
Explicit-value constructor.

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)

getChangelistId

public int getChangelistId()

setChangelistId

public UnlockFilesOptions setChangelistId(int changelistId)

isForceUnlock

public boolean isForceUnlock()

setForceUnlock

public UnlockFilesOptions setForceUnlock(boolean forceUnlock)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.