org.opensolaris.opengrok.history
Class SubversionRepository

java.lang.Object
  extended by org.opensolaris.opengrok.history.ExternalRepository
      extended by org.opensolaris.opengrok.history.SubversionRepository

public class SubversionRepository
extends ExternalRepository

Access to a Subversion repository.


Constructor Summary
SubversionRepository()
          Creates a new instance of SubversionRepository
SubversionRepository(java.lang.String directory)
          Creates a new instance of SubversionRepository
 
Method Summary
 Annotation annotate(java.io.File file, java.lang.String revision)
          Annotate the specified revision of a file.
 boolean fileHasHistory(java.io.File file)
           
 java.lang.Class<? extends org.opensolaris.opengrok.history.HistoryParser> getDirectoryHistoryParser()
           
 java.io.InputStream getHistoryGet(java.lang.String parent, java.lang.String basename, java.lang.String rev)
          Get an input stream that I may use to read a speciffic version of a named file.
 java.lang.Class<? extends org.opensolaris.opengrok.history.HistoryParser> getHistoryParser()
          Get a parser capable of getting history log elements from this repository.
 boolean isCacheable()
          Check whether the parsed history should be cached.
 boolean isIgnored()
           
 boolean isVerbose()
          Use verbose log messages, or just the summary
 void setIgnored(boolean ignored)
           
 void setVerbose(boolean verbose)
          Specify if verbose log messages or just the summary should be used
 boolean supportsAnnotation()
          Checks whether this parser can annotate files.
 void update()
          Update the content in this repository by pulling the changes from the upstream repository..
 
Methods inherited from class org.opensolaris.opengrok.history.ExternalRepository
getDirectoryName, setDirectoryName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubversionRepository

public SubversionRepository()
Creates a new instance of SubversionRepository


SubversionRepository

public SubversionRepository(java.lang.String directory)
Creates a new instance of SubversionRepository

Parameters:
directory - The directory containing the .svn-subdirectory
Method Detail

isVerbose

public boolean isVerbose()
Use verbose log messages, or just the summary

Returns:
true if verbose log messages are used for this repository

setVerbose

public void setVerbose(boolean verbose)
Specify if verbose log messages or just the summary should be used

Parameters:
verbose - set to true if verbose messages should be used

getHistoryGet

public java.io.InputStream getHistoryGet(java.lang.String parent,
                                         java.lang.String basename,
                                         java.lang.String rev)
Description copied from class: ExternalRepository
Get an input stream that I may use to read a speciffic version of a named file.

Parameters:
parent - the name of the directory containing the file
basename - the name of the file to get
rev - the revision to get
Returns:
An input stream containing the correct revision.

getHistoryParser

public java.lang.Class<? extends org.opensolaris.opengrok.history.HistoryParser> getHistoryParser()
Description copied from class: ExternalRepository
Get a parser capable of getting history log elements from this repository.

Returns:
a specialized parser for this kind of repository

getDirectoryHistoryParser

public java.lang.Class<? extends org.opensolaris.opengrok.history.HistoryParser> getDirectoryHistoryParser()

isIgnored

public boolean isIgnored()

setIgnored

public void setIgnored(boolean ignored)

annotate

public Annotation annotate(java.io.File file,
                           java.lang.String revision)
                    throws java.lang.Exception
Description copied from class: ExternalRepository
Annotate the specified revision of a file.

Parameters:
file - the file to annotate
revision - revision of the file
Returns:
an Annotation object
Throws:
java.lang.Exception - if an error occurs

supportsAnnotation

public boolean supportsAnnotation()
Description copied from class: ExternalRepository
Checks whether this parser can annotate files.

Returns:
true if annotation is supported

isCacheable

public boolean isCacheable()
Description copied from class: ExternalRepository
Check whether the parsed history should be cached.

Returns:
true if the history should be cached

fileHasHistory

public boolean fileHasHistory(java.io.File file)

update

public void update()
            throws java.lang.Exception
Description copied from class: ExternalRepository
Update the content in this repository by pulling the changes from the upstream repository..

Throws:
java.lang.Exception - if an error occurs.