Java Doc for ISVNOptions.java in  » Source-Control » tmatesoft-SVN » org » tmatesoft » svn » core » wc » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Like the Subversion client library SVNKit uses configuration options during runtime. ISVNOptions is intended for managing those options which are similar to ones you can meet in the config file located in the default Subversion configuration area - on Windows platforms it's usually located in the 'Documents and Settings\UserName\Subversion' (or simply '%APPDATA%\Subversion') directory, on Unix-like platforms - in '~/.subversion'. ISVNOptions is not intended for managing those options that can be met in the servers file (located in the same directory as config) - options for network layers are managed by interfaces and classes of the org.tmatesoft.svn.core.auth package.

Every SVN*Client's public constructor receives an ISVNOptions as a driver of the run-time configuration options. SVNClientManager also has got several newInstance() methods that receive an options driver. Thus it's simpe to implement a specific options driver to ISVNOptions and use it instead of a default one. However if you are not interested in customizing the run-time configuration area you can use a default driver which uses config info from the default SVN configuration area (see above).

Use SVNWCUtil to get a default options driver, like this:

 import org.tmatesoft.svn.core.wc.ISVNOptions;
 import org.tmatesoft.svn.core.wc.SVNClientManager;
 ...
 //here the only one boolean parameter - readonly - enables
 //or disables writing to the config file: if true (like in this snippet) -
 //SVNKit can only read options from the config file but not write
 ISVNOptions options = SVNWCUtil.createDefaultOptions(true);
 SVNClientManager clientManager = SVNClientManager.newInstance(options, "name", "password");
 ...

If you would like to have the default configuration area in a place different from the SVN default one, you should provide a preferred path to the config directory like this:

 import org.tmatesoft.svn.core.wc.ISVNOptions;
 import org.tmatesoft.svn.core.wc.SVNClientManager;
 ...
 File defaultConfigDir = new File("way/to/your/config/dir"); 
 ISVNOptions options = SVNWCUtil.createDefaultOptions(defaultConfigDir, true);
 SVNClientManager clientManager = SVNClientManager.newInstance(options, "name", "password");
 ...

Read also this Subversion book chapter on runtime configuration area.
version:
   1.1.1
author:
   TMate Software Ltd.
See Also:   SVNWCUtil
See Also:    Examples

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations.

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations.

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations.

The auth storage is used for disk-caching of all authentication information: usernames, passwords, server certificates, and any other types of cacheable credentials.

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations.

Autoproperties are the properties that are automatically set on files when they are added or imported.

If fileName matches any known file name pattern then all properties set for that pattern will be collected and placed into target.

For one file name pattern there can be several autoproperties set, delimited by ";".
Parameters:
  file - a target file
Parameters:
  target - a java.util.Map that will receiveautoproperties target itself

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations. Similar to the 'global-ignores' option that can be found in the SVN's config file under the [miscellany] section. an array of patterns (that usually contain wildcards)that specify file and directory names to be ignored untilthey are versioned
See Also:   ISVNOptions.setIgnorePatterns(String[])

The auth storage is used for disk-caching of all authentication information: usernames, passwords, server certificates, and any other types of cacheable credentials.

This option corresponds to the 'store-auth-creds' option that can be found in the SVN's config file under the [auth] section. true if auth storageis enabled, otherwise false
See Also:   ISVNOptions.setAuthStorageEnabled(boolean)

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations. Similar to the 'global-ignores' option that can be found in the SVN's config file under the [miscellany] section.
Parameters:
  name - a file name true if the fileis ignored, otherwise false

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations. Similar to the 'global-ignores' option that can be found in the SVN's config file under the [miscellany] section.
Parameters:
  file - a file true if the fileis ignored, otherwise false

Autoproperties are the properties that are automatically set on files when they are added or imported.

This option corresponds to the 'enable-auto-props' option that can be found in the SVN's config file under the [miscellany] section. true if autopropertiesare enabled, otherwise false
See Also:   ISVNOptions.setUseAutoProperties(boolean)
See Also:   

The commit-times option makes checkout/update/switch/revert operations put last-committed timestamps on every file they touch.

This option corresponds to the 'use-commit-times' option that can be found in the SVN's config file under the [miscellany] section. true if commit-timesare enabled, otherwise false
See Also:   ISVNOptions.setUseCommitTimes(boolean)
See Also:   

The auth storage is used for disk-caching of all authentication information: usernames, passwords, server certificates, and any other types of cacheable credentials.

This option corresponds to the 'store-auth-creds' option that can be found in the SVN's config file under the [auth] section.
Parameters:
  storeAuth - true to enable the auth storage, falseto disable
See Also:   ISVNOptions.isAuthStorageEnabled()

There can be several properties specified for one file pattern - they should be delimited by ";".
Parameters:
  autoProperties - a java.util.Map which keys are filename patterns and their values are strings in the form of "propName=propValue"
See Also:   ISVNOptions.getAutoProperties()

The global ignore patterns describe the names of files and directories that SVNKit should ignore during status, add and import operations. Similar to the 'global-ignores' option that can be found in the SVN's config file under the [miscellany] section.

For example, to set all .exe files to be ignored include "*.exe" pattern into patterns.

If patterns is null or empty then all the patterns will be removed.
Parameters:
  patterns - an array of patterns (that usually contain wildcards)that specify file and directory names to be ignored untilthey are versioned
See Also:   ISVNOptions.getIgnorePatterns()

Autoproperties are the properties that are automatically set on files when they are added or imported.

This option corresponds to the 'enable-auto-props' option that can be found in the SVN's config file under the [miscellany] section.
Parameters:
  useAutoProperties - true to enable autoproperties, falseto disable
See Also:   ISVNOptions.isUseAutoProperties()

The commit-times option makes checkout/update/switch/revert operations put last-committed timestamps on every file they touch.

This option corresponds to the 'use-commit-times' option that can be found in the SVN's config file under the [miscellany] section.
Parameters:
  useCommitTimes - true to enable commit-times, falseto disable
See Also:   ISVNOptions.isUseCommitTimes()
See Also: