VersionedMetaData (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.git.VersionedMetaData

Direct Known Subclasses:

ProjectConfig, ProjectLevelConfig, VersionedAccountDestinations, VersionedAccountPreferences, VersionedAccountQueries, VersionedAuthorizedKeys, WatchConfig
```
public abstract class VersionedMetaData
extends java.lang.Object
```
Support for metadata stored within a version controlled branch.
Implementors are responsible for supplying implementations of the onLoad and onSave methods to read from the repository, or format an update that can later be written back to the repository.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`VersionedMetaData.BatchMetaDataUpdate`
`static class`	`VersionedMetaData.PathInfo` Path information that does not hold references to any repository data structures, allowing the application to retain this object for long periods of time.

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.eclipse.jgit.lib.ObjectInserter`	`inserter`
`protected org.eclipse.jgit.dircache.DirCache`	`newTree`
`protected org.eclipse.jgit.lib.ObjectReader`	`reader`
`protected org.eclipse.jgit.revwalk.RevCommit`	`revision`

Constructor Summary

Constructors
Constructor and Description

VersionedMetaData()

Constructors
Constructor and Description
`VersionedMetaData()`

Method Summary

Methods
Modifier and Type	Method and Description
`org.eclipse.jgit.revwalk.RevCommit`	`commit(MetaDataUpdate update)` Update this metadata branch, recording a new commit on its reference.
`org.eclipse.jgit.revwalk.RevCommit`	`commitToNewRef(MetaDataUpdate update, java.lang.String refName)` Creates a new commit and a new ref based on this commit.
`protected org.eclipse.jgit.lib.ObjectId`	`getObjectId(java.lang.String fileName)`
`java.util.List<VersionedMetaData.PathInfo>`	`getPathInfos(boolean recursive)`
`protected abstract java.lang.String`	`getRefName()`
`org.eclipse.jgit.lib.ObjectId`	`getRevision()`
`void`	`load(MetaDataUpdate update)`
`void`	`load(MetaDataUpdate update, org.eclipse.jgit.lib.ObjectId id)`
`void`	`load(org.eclipse.jgit.lib.Repository db)` Load the current version from the branch.
`void`	`load(org.eclipse.jgit.lib.Repository db, org.eclipse.jgit.lib.ObjectId id)` Load a specific version from the repository.
`void`	`load(org.eclipse.jgit.revwalk.RevWalk walk, org.eclipse.jgit.lib.ObjectId id)` Load a specific version from an open walk.
`protected abstract void`	`onLoad()` Set up the metadata, parsing any state from the loaded revision.
`protected abstract boolean`	`onSave(org.eclipse.jgit.lib.CommitBuilder commit)` Save any changes to the metadata in a commit.
`VersionedMetaData.BatchMetaDataUpdate`	`openUpdate(MetaDataUpdate update)` Open a batch of updates to the same metadata ref.
`protected org.eclipse.jgit.lib.Config`	`readConfig(java.lang.String fileName)`
`protected byte[]`	`readFile(java.lang.String fileName)`
`protected org.eclipse.jgit.dircache.DirCache`	`readTree(org.eclipse.jgit.revwalk.RevTree tree)`
`protected java.lang.String`	`readUTF8(java.lang.String fileName)`
`protected void`	`saveConfig(java.lang.String fileName, org.eclipse.jgit.lib.Config cfg)`
`protected void`	`saveFile(java.lang.String fileName, byte[] raw)`
`protected void`	`saveUTF8(java.lang.String fileName, java.lang.String text)`
`protected static void`	`set(org.eclipse.jgit.lib.Config rc, java.lang.String section, java.lang.String subsection, java.lang.String name, boolean value)`
`protected static <E extends java.lang.Enum<?>> void`	`set(org.eclipse.jgit.lib.Config rc, java.lang.String section, java.lang.String subsection, java.lang.String name, E value, E defaultValue)`
`protected static void`	`set(org.eclipse.jgit.lib.Config rc, java.lang.String section, java.lang.String subsection, java.lang.String name, java.lang.String value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

revision

protected org.eclipse.jgit.revwalk.RevCommit revision

reader

protected org.eclipse.jgit.lib.ObjectReader reader

inserter

protected org.eclipse.jgit.lib.ObjectInserter inserter

newTree

protected org.eclipse.jgit.dircache.DirCache newTree

Constructor Detail
- VersionedMetaData
```
public VersionedMetaData()
```

Method Detail

getRefName
```
protected abstract java.lang.String getRefName()
```
Returns:
name of the reference storing this configuration.

onLoad

protected abstract void onLoad()
                        throws java.io.IOException,
                               org.eclipse.jgit.errors.ConfigInvalidException

Set up the metadata, parsing any state from the loaded revision.

Throws:: java.io.IOException; org.eclipse.jgit.errors.ConfigInvalidException

onSave

protected abstract boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)
                           throws java.io.IOException,
                                  org.eclipse.jgit.errors.ConfigInvalidException

Save any changes to the metadata in a commit.

Returns:: true if the commit should proceed, false to abort.
Throws:: java.io.IOException; org.eclipse.jgit.errors.ConfigInvalidException

getRevision
```
public org.eclipse.jgit.lib.ObjectId getRevision()
```
Returns:
revision of the metadata that was loaded.

load
```
public void load(org.eclipse.jgit.lib.Repository db)
          throws java.io.IOException,
                 org.eclipse.jgit.errors.ConfigInvalidException
```
Load the current version from the branch.
The repository is not held after the call completes, allowing the application to retain this object for long periods of time.

Parameters:
db - repository to access.

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

load
```
public void load(org.eclipse.jgit.lib.Repository db,
        org.eclipse.jgit.lib.ObjectId id)
          throws java.io.IOException,
                 org.eclipse.jgit.errors.ConfigInvalidException
```
Load a specific version from the repository.
This method is primarily useful for applying updates to a specific revision that was shown to an end-user in the user interface. If there are conflicts with another user's concurrent changes, these will be automatically detected at commit time.
The repository is not held after the call completes, allowing the application to retain this object for long periods of time.

Parameters:
db - repository to access.
id - revision to load.

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

load
```
public void load(org.eclipse.jgit.revwalk.RevWalk walk,
        org.eclipse.jgit.lib.ObjectId id)
          throws java.io.IOException,
                 org.eclipse.jgit.errors.ConfigInvalidException
```
Load a specific version from an open walk.
This method is primarily useful for applying updates to a specific revision that was shown to an end-user in the user interface. If there are conflicts with another user's concurrent changes, these will be automatically detected at commit time.
The caller retains ownership of the walk and is responsible for closing it. However, this instance does not hold a reference to the walk or the repository after the call completes, allowing the application to retain this object for long periods of time.

Parameters:
walk - open walk to access to access.
id - revision to load.

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

load

public void load(MetaDataUpdate update)
          throws java.io.IOException,
                 org.eclipse.jgit.errors.ConfigInvalidException

Throws:: java.io.IOException; org.eclipse.jgit.errors.ConfigInvalidException

load

public void load(MetaDataUpdate update,
        org.eclipse.jgit.lib.ObjectId id)
          throws java.io.IOException,
                 org.eclipse.jgit.errors.ConfigInvalidException

Throws:: java.io.IOException; org.eclipse.jgit.errors.ConfigInvalidException

commit
```
public org.eclipse.jgit.revwalk.RevCommit commit(MetaDataUpdate update)
                                          throws java.io.IOException
```
Update this metadata branch, recording a new commit on its reference.

Parameters:
update - helper information to define the update that will occur.

Returns:
the commit that was created

Throws:

java.io.IOException - if there is a storage problem and the update cannot be executed as requested or if it failed because of a concurrent update to the same reference

commitToNewRef
```
public org.eclipse.jgit.revwalk.RevCommit commitToNewRef(MetaDataUpdate update,
                                                java.lang.String refName)
                                                  throws java.io.IOException
```
Creates a new commit and a new ref based on this commit.

Parameters:
update - helper information to define the update that will occur.
refName - name of the ref that should be created

Returns:
the commit that was created

Throws:

java.io.IOException - if there is a storage problem and the update cannot be executed as requested or if it failed because of a concurrent update to the same reference

openUpdate
```
public VersionedMetaData.BatchMetaDataUpdate openUpdate(MetaDataUpdate update)
                                                 throws java.io.IOException
```
Open a batch of updates to the same metadata ref.
This allows making multiple commits to a single metadata ref, at the end of which is a single ref update. For batching together updates to multiple refs (each consisting of one or more commits against their respective refs), create the MetaDataUpdate with a BatchRefUpdate.
A ref update produced by this VersionedMetaData.BatchMetaDataUpdate is only committed if there is no associated BatchRefUpdate. As a result, the configured ref updated event is not fired if there is an associated batch.

Parameters:
update - helper info about the update.

Throws:

java.io.IOException - if the update failed.

readTree

protected org.eclipse.jgit.dircache.DirCache readTree(org.eclipse.jgit.revwalk.RevTree tree)
                                               throws java.io.IOException,
                                                      org.eclipse.jgit.errors.MissingObjectException,
                                                      org.eclipse.jgit.errors.IncorrectObjectTypeException

Throws:: java.io.IOException; org.eclipse.jgit.errors.MissingObjectException; org.eclipse.jgit.errors.IncorrectObjectTypeException

readConfig

protected org.eclipse.jgit.lib.Config readConfig(java.lang.String fileName)
                                          throws java.io.IOException,
                                                 org.eclipse.jgit.errors.ConfigInvalidException

Throws:: java.io.IOException; org.eclipse.jgit.errors.ConfigInvalidException

readUTF8

protected java.lang.String readUTF8(java.lang.String fileName)
                             throws java.io.IOException

Throws:: java.io.IOException

readFile

protected byte[] readFile(java.lang.String fileName)
                   throws java.io.IOException

Throws:: java.io.IOException

getObjectId

protected org.eclipse.jgit.lib.ObjectId getObjectId(java.lang.String fileName)
                                             throws java.io.IOException

Throws:: java.io.IOException

getPathInfos

public java.util.List<VersionedMetaData.PathInfo> getPathInfos(boolean recursive)
                                                        throws java.io.IOException

Throws:: java.io.IOException

set

protected static void set(org.eclipse.jgit.lib.Config rc,
       java.lang.String section,
       java.lang.String subsection,
       java.lang.String name,
       java.lang.String value)

set

protected static void set(org.eclipse.jgit.lib.Config rc,
       java.lang.String section,
       java.lang.String subsection,
       java.lang.String name,
       boolean value)

set

protected static <E extends java.lang.Enum<?>> void set(org.eclipse.jgit.lib.Config rc,
                                     java.lang.String section,
                                     java.lang.String subsection,
                                     java.lang.String name,
                                     E value,
                                     E defaultValue)

saveConfig

protected void saveConfig(java.lang.String fileName,
              org.eclipse.jgit.lib.Config cfg)
                   throws java.io.IOException

Throws:: java.io.IOException

saveUTF8

protected void saveUTF8(java.lang.String fileName,
            java.lang.String text)
                 throws java.io.IOException

Throws:: java.io.IOException

saveFile

protected void saveFile(java.lang.String fileName,
            byte[] raw)
                 throws java.io.IOException

Throws:: java.io.IOException

Class VersionedMetaData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

revision

reader

inserter

newTree

Constructor Detail

VersionedMetaData

Method Detail

getRefName

onLoad

onSave

getRevision

load

load

load

load

load

commit

commitToNewRef

openUpdate

readTree

readConfig

readUTF8

readFile

getObjectId

getPathInfos

set

set

set

saveConfig

saveUTF8

saveFile