Package org.tmatesoft.svn.core.internal.wc

Class DefaultSVNOptions

java.lang.Object
org.tmatesoft.svn.core.internal.wc.DefaultSVNOptions
All Implemented Interfaces:
ISVNTunnelProvider, ISVNMergerFactory, ISVNOptions
public class DefaultSVNOptions extends Object implements ISVNOptions, ISVNMergerFactory
Version:
1.3

  • Field Details

  • Constructor Details

    • DefaultSVNOptions

      public DefaultSVNOptions()

    • DefaultSVNOptions

      public DefaultSVNOptions(File directory, boolean readOnly)

  • Method Details

    • isUseCommitTimes

      public boolean isUseCommitTimes()
      Description copied from interface: ISVNOptions
      Determines if the commit-times option is enabled.

      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.

      Specified by:
      isUseCommitTimes in interface ISVNOptions
      Returns:
      true if commit-times are enabled, otherwise false

    • setInMemoryConfigOptions

      public void setInMemoryConfigOptions(Map configOptions)

    • setUseCommitTimes

      public void setUseCommitTimes(boolean useCommitTimes)
      Enables or disables the commit-times option.

      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, false to disable
      See Also:

    • isUseAutoProperties

      public boolean isUseAutoProperties()
      Determines if the autoproperties option is enabled.

      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.

      Returns:
      true if autoproperties are enabled, otherwise false

    • setUseAutoProperties

      public void setUseAutoProperties(boolean useAutoProperties)
      Enables or disables the autoproperties option.

      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, false to disable
      See Also:

    • isAuthStorageEnabled

      public boolean isAuthStorageEnabled()
      Determines if the authentication storage is enabled.

      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.

      Returns:
      true if auth storage is enabled, otherwise false

    • isKeepLocks

      public boolean isKeepLocks()

    • setAuthStorageEnabled

      public void setAuthStorageEnabled(boolean storeAuth)
      Enables or disables the authentication storage.

      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, false to disable
      See Also:

    • setKeepLocks

      public void setKeepLocks(boolean keep)

    • isIgnored

      public static boolean isIgnored(ISVNOptions options, String name)

    • getIgnorePatterns

      public String[] getIgnorePatterns()
      Description copied from interface: ISVNOptions
      Returns all the global ignore patterns.

      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.

      Specified by:
      getIgnorePatterns in interface ISVNOptions
      Returns:
      an array of patterns (that usually contain wildcards) that specify file and directory names to be ignored until they are versioned

    • setIgnorePatterns

      public void setIgnorePatterns(String[] patterns)
      Sets global ignore patterns.

      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 until they are versioned
      See Also:

    • deleteIgnorePattern

      public void deleteIgnorePattern(String pattern)
      Removes a particular global ignore pattern.
      Parameters:
      pattern - a patterna to be removed
      See Also:

    • addIgnorePattern

      public void addIgnorePattern(String pattern)
      Adds a new particular ignore pattern to global ignore patterns.
      Parameters:
      pattern - an ignore pattern to be added
      See Also:

    • getAutoProperties

      public Map getAutoProperties()
      Returns autoproperties as a Map where each key is a file name pattern and the corresponding value is a string in the form of "propName=propValue".
      Returns:
      a Map containing autoproperties

    • setAutoProperties

      public void setAutoProperties(Map autoProperties)
      Sets autoproperties that will be automatically put on all files that will be added or imported.

      There can be several properties specified for one file pattern - they should be delimited by ";".

      Parameters:
      autoProperties - a Map which keys are file name patterns and their values are strings in the form of "propName=propValue"
      See Also:

    • getEditor

      public String getEditor()

    • getMergeTool

      public String getMergeTool()

    • deleteAutoProperty

      public void deleteAutoProperty(String pattern)
      Removes a particular autoproperty by specifying a file name pattern.
      Parameters:
      pattern - a file name pattern
      See Also:

    • setAutoProperty

      public void setAutoProperty(String pattern, String properties)
      Sets an autoproperty - binds a file name pattern with a string in the form of "propName=propValue".
      Parameters:
      pattern - a file name pattern (usually containing wildcards)
      properties - a property for pattern

    • isInteractiveConflictResolution

      public boolean isInteractiveConflictResolution()

    • setInteractiveConflictResolution

      public void setInteractiveConflictResolution(boolean interactive)

    • applyAutoProperties

      public Map applyAutoProperties(File file, Map target)
      Description copied from interface: ISVNOptions
      Collects and puts into a Map all autoproperties specified for the file name pattern matched by the target file name.

      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 ";".

      Specified by:
      applyAutoProperties in interface ISVNOptions
      Parameters:
      file - a target file
      target - a Map that will receive autoproperties
      Returns:
      target itself

    • getMergerFactory

      public ISVNMergerFactory getMergerFactory()
      Description copied from interface: ISVNOptions
      Returns a factory object which is responsible for creating merger drivers.
      Specified by:
      getMergerFactory in interface ISVNOptions
      Returns:
      a factory that produces merger drivers for merge operations

    • setMergerFactory

      public void setMergerFactory(ISVNMergerFactory mergerFactory)
      Sets a factory object which is responsible for creating merger drivers.
      Parameters:
      mergerFactory - a factory that produces merger drivers for merge operations
      See Also:

    • getPropertyValue

      public String getPropertyValue(String propertyName)
      Returns the value of a property from the [svnkit] section of the config file.
      Parameters:
      propertyName - a SVNKit specific config property name
      Returns:
      the value of the property

    • getHttpSpoolDirectory

      public File getHttpSpoolDirectory()

    • setPropertyValue

      public void setPropertyValue(String propertyName, String propertyValue)
      Sets the value of a property from the [svnkit] section of the config file.
      Parameters:
      propertyName - a SVNKit specific config property name
      propertyValue - a new value for the property; if null the property is removed

    • setConflictHandler

      public void setConflictHandler(ISVNConflictHandler resolver)

    • getConflictResolver

      public ISVNConflictHandler getConflictResolver()
      Specified by:
      getConflictResolver in interface ISVNOptions

    • matches

      public static boolean matches(String pattern, String fileName)

    • createMerger

      public ISVNMerger createMerger(byte[] conflictStart, byte[] conflictSeparator, byte[] conflictEnd)
      Description copied from interface: ISVNMergerFactory
      Creates a new merger driver.

      If a merger driver can not cleanly apply delta to a file (in case of a conflict state) then for each conflicting contents fragment the driver puts local data between the specified conflictStart and conflictSeparator bytes, and the newcomer data between the specified conflictSeparator and conflictEnd ones. And all these bytes are then written to the file in the place of a conflict.

      Specified by:
      createMerger in interface ISVNMergerFactory
      Parameters:
      conflictStart - bytes that come in the very beginning of a conflict
      conflictSeparator - bytes that are used to separate two conflicting fragments - local data and the newcomer one
      conflictEnd - bytes that come in the very end of a conflict
      Returns:
      a merger driver

    • createTunnelConnector

      public ISVNConnector createTunnelConnector(SVNURL url)
      Description copied from interface: ISVNTunnelProvider
      Returns a tunnel comand line matching the given subprotocol name.
      Specified by:
      createTunnelConnector in interface ISVNTunnelProvider
      Returns:
      a tunnel command line

    • getKeywordDateFormat

      public DateFormat getKeywordDateFormat()
      Description copied from interface: ISVNOptions
      Returns the date format used to format datestamps.
      Specified by:
      getKeywordDateFormat in interface ISVNOptions
      Returns:
      date format

    • getPreservedConflictFileExtensions

      public String[] getPreservedConflictFileExtensions()
      Description copied from interface: ISVNOptions
      Returns an array of path extensions which the user wants to preserve when conflict files are made.

      If the extension of a conflicted path does not match any of the returned by this method or if this method returns null, the extension (if any) of the conflicted file will be cut off.

      Specified by:
      getPreservedConflictFileExtensions in interface ISVNOptions
      Returns:
      array of preserved file extensions

    • isAllowAllForwardMergesFromSelf

      public boolean isAllowAllForwardMergesFromSelf()
      Description copied from interface: ISVNOptions
      Says to a merge driver whether to allow all forward merges or not.

      If this returns true, we allow all forward-merges not already found in recorded mergeinfo, and thus we destroy the ability to, say, merge the whole of a branch to the trunk while automatically ignoring the revisions common to both.

      If this returns false, we allow only forward-merges not found in either recorded mergeinfo or implicit mergeinfo (natural history), then the previous scenario works great, but we can't reverse-merge a previous change made to our line of history and then remake it (because the reverse-merge will leave no mergeinfo trace, and the remake-it attempt will still find the original change in natural mergeinfo.

      Specified by:
      isAllowAllForwardMergesFromSelf in interface ISVNOptions
      Returns:
      true to allow all forward-merges; otherwise false

    • getLogEncoding

      public String getLogEncoding()

    • getGlobalCharset

      public String getGlobalCharset()

    • setGlobalCharset

      public void setGlobalCharset(String charset)

    • getNativeCharset

      public String getNativeCharset()
      Description copied from interface: ISVNOptions
      Returns the native charset name. See also SVNProperty.NATIVE.
      Specified by:
      getNativeCharset in interface ISVNOptions
      Returns:
      native charset name

    • getNativeEOL

      public byte[] getNativeEOL()
      Description copied from interface: ISVNOptions
      Returns the native EOL marker bytes.
      Specified by:
      getNativeEOL in interface ISVNOptions
      Returns:
      native EOL bytes

    • getFileExtensionsToMimeTypes

      public Map getFileExtensionsToMimeTypes()
      Description copied from interface: ISVNOptions
      Returns a hash holding file extensions to MIME types mappings. Extensions must not include the leading dot in their names.
      Specified by:
      getFileExtensionsToMimeTypes in interface ISVNOptions
      Returns:
      map which keys are String file extensions, and values are String MIME types

    • getDiffCommand

      public String getDiffCommand()

    • setDiffCommand

      public void setDiffCommand(String diffCmd)

    • getPasswordStorageTypes

      public String[] getPasswordStorageTypes()

    • getDefaultSSHCommandLine

      private String getDefaultSSHCommandLine()

    • getDefaultSSHOptionValue

      private String getDefaultSSHOptionValue(String optionName, String systemProperty, String fallbackSystemProperty)

    • getDefaultSSHPortNumber

      public int getDefaultSSHPortNumber()

    • getDefaultSSHUserName

      public String getDefaultSSHUserName()

    • getDefaultSSHPassword

      public String getDefaultSSHPassword()

    • getDefaultSSHKeyFile

      public String getDefaultSSHKeyFile()

    • getDefaultSSHPassphrase

      public String getDefaultSSHPassphrase()

    • getConfigFile

      private SVNCompositeConfigFile getConfigFile()

    • getOptionValue

      private static String getOptionValue(String commandLine, String optionName)

    • compileNamePatter

      private static Pattern compileNamePatter(String wildcard)

    • toLocale

      private static Locale toLocale(String str)

    • getDefaultConfigDir

      private static File getDefaultConfigDir()

    • getBooleanValue

      public static boolean getBooleanValue(String value, boolean defaultValue)

    • getLongValue

      public static long getLongValue(String value, long defaultValue)