github
/
jgit
mirror of https://gitee.com/github-mirror-repo/jgit.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

Fix javadoc in org.eclipse.jgit nls and notes package 

Change-Id: I1b65fba5b4856f98974dc10f549540d401ef916f
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
stable-4.10
Matthias Sohn 7 years ago
parent
a2f2f65390
commit
463dad2ed6
8 changed files with 94 additions and 71 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 18
      org.eclipse.jgit/src/org/eclipse/jgit/nls/NLS.java
  2. 36
      org.eclipse.jgit/src/org/eclipse/jgit/nls/TranslationBundle.java
  3. 3
      org.eclipse.jgit/src/org/eclipse/jgit/notes/DefaultNoteMerger.java
  4. 11
      org.eclipse.jgit/src/org/eclipse/jgit/notes/Note.java
  5. 63
      org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMap.java
  6. 19
      org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMapMerger.java
  7. 10
      org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMerger.java
  8. 5
      org.eclipse.jgit/src/org/eclipse/jgit/notes/NotesMergeConflictException.java

18
org.eclipse.jgit/src/org/eclipse/jgit/nls/NLS.java
Unescape View File

@ -68,7 +68,10 @@ import org.eclipse.jgit.errors.TranslationStringMissingException;
* </pre> * </pre>
*/ */
public class NLS { public class NLS {
/** The root locale constant. It is defined here because the Locale.ROOT is not defined in Java 5 */ /**
* The root locale constant. It is defined here because the Locale.ROOT is
* not defined in Java 5
*/
public static final Locale ROOT_LOCALE = new Locale("", "", ""); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ public static final Locale ROOT_LOCALE = new Locale("", "", ""); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
private static final InheritableThreadLocal<NLS> local = new InheritableThreadLocal<NLS>() { private static final InheritableThreadLocal<NLS> local = new InheritableThreadLocal<NLS>() {
@ -105,15 +108,18 @@ public class NLS {
/** /**
* Returns an instance of the translation bundle of the required type. All * Returns an instance of the translation bundle of the required type. All
* public String fields of the bundle instance will get their values * public String fields of the bundle instance will get their values
* injected as described in the {@link TranslationBundle}. * injected as described in the
* {@link org.eclipse.jgit.nls.TranslationBundle}.
* *
* @param <T>
* required bundle type
* @param type * @param type
* required bundle type * required bundle type
* @return an instance of the required bundle type * @return an instance of the required bundle type
* @exception TranslationBundleLoadingException see {@link TranslationBundleLoadingException} * @exception TranslationBundleLoadingException
* @exception TranslationStringMissingException see {@link TranslationStringMissingException} * see
* {@link org.eclipse.jgit.errors.TranslationBundleLoadingException}
* @exception TranslationStringMissingException
* see
* {@link org.eclipse.jgit.errors.TranslationStringMissingException}
*/ */
public static <T extends TranslationBundle> T getBundleFor(Class<T> type) { public static <T extends TranslationBundle> T getBundleFor(Class<T> type) {
return local.get().get(type); return local.get().get(type);

36
org.eclipse.jgit/src/org/eclipse/jgit/nls/TranslationBundle.java
Unescape View File

@ -92,21 +92,22 @@ import org.eclipse.jgit.errors.TranslationStringMissingException;
* </pre> * </pre>
* *
* The translated text is automatically injected into the public String fields * The translated text is automatically injected into the public String fields
* according to the locale set with {@link NLS#setLocale(Locale)}. However, the * according to the locale set with
* {@link NLS#setLocale(Locale)} method defines only prefered locale which will * {@link org.eclipse.jgit.nls.NLS#setLocale(Locale)}. However, the
* be honored only if it is supported by the provided resource bundle property * {@link org.eclipse.jgit.nls.NLS#setLocale(Locale)} method defines only
* files. Basically, this class will use * prefered locale which will be honored only if it is supported by the provided
* {@link ResourceBundle#getBundle(String, Locale)} method to load a resource * resource bundle property files. Basically, this class will use
* bundle. See the documentation of this method for a detailed explanation of * {@link java.util.ResourceBundle#getBundle(String, Locale)} method to load a
* resource bundle loading strategy. After a bundle is created the * resource bundle. See the documentation of this method for a detailed
* {@link #effectiveLocale()} method can be used to determine whether the bundle * explanation of resource bundle loading strategy. After a bundle is created
* really corresponds to the requested locale or is a fallback. * the {@link #effectiveLocale()} method can be used to determine whether the
* bundle really corresponds to the requested locale or is a fallback.
* *
* <p> * <p>
* To load a String from a resource bundle property file this class uses the * To load a String from a resource bundle property file this class uses the
* {@link ResourceBundle#getString(String)}. This method can throw the * {@link java.util.ResourceBundle#getString(String)}. This method can throw the
* {@link MissingResourceException} and this class is not making any effort to * {@link java.util.MissingResourceException} and this class is not making any
* catch and/or translate this exception. * effort to catch and/or translate this exception.
* *
* <p> * <p>
* To define a concrete translation bundle one has to: * To define a concrete translation bundle one has to:
@ -125,15 +126,20 @@ public abstract class TranslationBundle {
private ResourceBundle resourceBundle; private ResourceBundle resourceBundle;
/** /**
* @return the locale locale used for loading the resource bundle from which * Get the locale used for loading the resource bundle from which the field
* the field values were taken * values were taken.
*
* @return the locale used for loading the resource bundle from which the
* field values were taken.
*/ */
public Locale effectiveLocale() { public Locale effectiveLocale() {
return effectiveLocale; return effectiveLocale;
} }
/** /**
* @return the resource bundle on which this translation bundle is based * Get the resource bundle on which this translation bundle is based.
*
* @return the resource bundle on which this translation bundle is based.
*/ */
public ResourceBundle resourceBundle() { public ResourceBundle resourceBundle() {
return resourceBundle; return resourceBundle;

3
org.eclipse.jgit/src/org/eclipse/jgit/notes/DefaultNoteMerger.java
Unescape View File

@ -53,7 +53,7 @@ import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.util.io.UnionInputStream; import org.eclipse.jgit.util.io.UnionInputStream;
/** /**
* Default implementation of the {@link NoteMerger}. * Default implementation of the {@link org.eclipse.jgit.notes.NoteMerger}.
* <p> * <p>
* If ours and theirs are both non-null, which means they are either both edits * If ours and theirs are both non-null, which means they are either both edits
* or both adds, then this merger will simply join the content of ours and * or both adds, then this merger will simply join the content of ours and
@ -67,6 +67,7 @@ import org.eclipse.jgit.util.io.UnionInputStream;
*/ */
public class DefaultNoteMerger implements NoteMerger { public class DefaultNoteMerger implements NoteMerger {
/** {@inheritDoc} */
@Override @Override
public Note merge(Note base, Note ours, Note theirs, ObjectReader reader, public Note merge(Note base, Note ours, Note theirs, ObjectReader reader,
ObjectInserter inserter) throws IOException { ObjectInserter inserter) throws IOException {

11
org.eclipse.jgit/src/org/eclipse/jgit/notes/Note.java
Unescape View File

@ -46,7 +46,9 @@ package org.eclipse.jgit.notes;
import org.eclipse.jgit.lib.AnyObjectId; import org.eclipse.jgit.lib.AnyObjectId;
import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.ObjectId;
/** In-memory representation of a single note attached to one object. */ /**
* In-memory representation of a single note attached to one object.
*/
public class Note extends ObjectId { public class Note extends ObjectId {
private ObjectId data; private ObjectId data;
@ -63,7 +65,11 @@ public class Note extends ObjectId {
data = noteData; data = noteData;
} }
/** @return the note content */ /**
* Get the note content.
*
* @return the note content.
*/
public ObjectId getData() { public ObjectId getData() {
return data; return data;
} }
@ -72,6 +78,7 @@ public class Note extends ObjectId {
data = newData; data = newData;
} }
/** {@inheritDoc} */
@SuppressWarnings("nls") @SuppressWarnings("nls")
@Override @Override
public String toString() { public String toString() {

63
org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMap.java
Unescape View File

@ -63,10 +63,11 @@ import org.eclipse.jgit.revwalk.RevTree;
/** /**
* Index of notes from a note branch. * Index of notes from a note branch.
* *
* This class is not thread-safe, and relies on an {@link ObjectReader} that it * This class is not thread-safe, and relies on an
* borrows/shares with the caller. The reader can be used during any call, and * {@link org.eclipse.jgit.lib.ObjectReader} that it borrows/shares with the
* is not released by this class. The caller should arrange for releasing the * caller. The reader can be used during any call, and is not released by this
* shared {@code ObjectReader} at the proper times. * class. The caller should arrange for releasing the shared
* {@code ObjectReader} at the proper times.
*/ */
public class NoteMap implements Iterable<Note> { public class NoteMap implements Iterable<Note> {
/** /**
@ -81,10 +82,11 @@ public class NoteMap implements Iterable<Note> {
} }
/** /**
* Shorten the note ref name by trimming off the {@link Constants#R_NOTES} * Shorten the note ref name by trimming off the
* prefix if it exists. * {@link org.eclipse.jgit.lib.Constants#R_NOTES} prefix if it exists.
* *
* @param noteRefName * @param noteRefName
* a {@link java.lang.String} object.
* @return a more user friendly note name * @return a more user friendly note name
*/ */
public static String shortenRefName(String noteRefName) { public static String shortenRefName(String noteRefName) {
@ -103,13 +105,13 @@ public class NoteMap implements Iterable<Note> {
* @param commit * @param commit
* the revision of the note branch to read. * the revision of the note branch to read.
* @return the note map read from the commit. * @return the note map read from the commit.
* @throws IOException * @throws java.io.IOException
* the repository cannot be accessed through the reader. * the repository cannot be accessed through the reader.
* @throws CorruptObjectException * @throws org.eclipse.jgit.errors.CorruptObjectException
* a tree object is corrupt and cannot be read. * a tree object is corrupt and cannot be read.
* @throws IncorrectObjectTypeException * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
* a tree object wasn't actually a tree. * a tree object wasn't actually a tree.
* @throws MissingObjectException * @throws org.eclipse.jgit.errors.MissingObjectException
* a reference tree object doesn't exist. * a reference tree object doesn't exist.
*/ */
public static NoteMap read(ObjectReader reader, RevCommit commit) public static NoteMap read(ObjectReader reader, RevCommit commit)
@ -128,13 +130,13 @@ public class NoteMap implements Iterable<Note> {
* @param tree * @param tree
* the note tree to read. * the note tree to read.
* @return the note map read from the tree. * @return the note map read from the tree.
* @throws IOException * @throws java.io.IOException
* the repository cannot be accessed through the reader. * the repository cannot be accessed through the reader.
* @throws CorruptObjectException * @throws org.eclipse.jgit.errors.CorruptObjectException
* a tree object is corrupt and cannot be read. * a tree object is corrupt and cannot be read.
* @throws IncorrectObjectTypeException * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
* a tree object wasn't actually a tree. * a tree object wasn't actually a tree.
* @throws MissingObjectException * @throws org.eclipse.jgit.errors.MissingObjectException
* a reference tree object doesn't exist. * a reference tree object doesn't exist.
*/ */
public static NoteMap read(ObjectReader reader, RevTree tree) public static NoteMap read(ObjectReader reader, RevTree tree)
@ -153,13 +155,13 @@ public class NoteMap implements Iterable<Note> {
* @param treeId * @param treeId
* the note tree to read. * the note tree to read.
* @return the note map read from the tree. * @return the note map read from the tree.
* @throws IOException * @throws java.io.IOException
* the repository cannot be accessed through the reader. * the repository cannot be accessed through the reader.
* @throws CorruptObjectException * @throws org.eclipse.jgit.errors.CorruptObjectException
* a tree object is corrupt and cannot be read. * a tree object is corrupt and cannot be read.
* @throws IncorrectObjectTypeException * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
* a tree object wasn't actually a tree. * a tree object wasn't actually a tree.
* @throws MissingObjectException * @throws org.eclipse.jgit.errors.MissingObjectException
* a reference tree object doesn't exist. * a reference tree object doesn't exist.
*/ */
public static NoteMap readTree(ObjectReader reader, ObjectId treeId) public static NoteMap readTree(ObjectReader reader, ObjectId treeId)
@ -197,10 +199,7 @@ public class NoteMap implements Iterable<Note> {
this.reader = reader; this.reader = reader;
} }
/** /** {@inheritDoc} */
* @return an iterator that iterates over notes of this NoteMap. Non note
* entries are ignored by this iterator.
*/
@Override @Override
public Iterator<Note> iterator() { public Iterator<Note> iterator() {
try { try {
@ -216,7 +215,7 @@ public class NoteMap implements Iterable<Note> {
* @param id * @param id
* the object to look for. * the object to look for.
* @return the note's blob ObjectId, or null if no note exists. * @return the note's blob ObjectId, or null if no note exists.
* @throws IOException * @throws java.io.IOException
* a portion of the note space is not accessible. * a portion of the note space is not accessible.
*/ */
public ObjectId get(AnyObjectId id) throws IOException { public ObjectId get(AnyObjectId id) throws IOException {
@ -230,7 +229,7 @@ public class NoteMap implements Iterable<Note> {
* @param id * @param id
* the object to look for. * the object to look for.
* @return the note for the given object id, or null if no note exists. * @return the note for the given object id, or null if no note exists.
* @throws IOException * @throws java.io.IOException
* a portion of the note space is not accessible. * a portion of the note space is not accessible.
*/ */
public Note getNote(AnyObjectId id) throws IOException { public Note getNote(AnyObjectId id) throws IOException {
@ -243,7 +242,7 @@ public class NoteMap implements Iterable<Note> {
* @param id * @param id
* the object to look for. * the object to look for.
* @return true if a note exists; false if there is no note. * @return true if a note exists; false if there is no note.
* @throws IOException * @throws java.io.IOException
* a portion of the note space is not accessible. * a portion of the note space is not accessible.
*/ */
public boolean contains(AnyObjectId id) throws IOException { public boolean contains(AnyObjectId id) throws IOException {
@ -269,11 +268,11 @@ public class NoteMap implements Iterable<Note> {
* larger than this limit, LargeObjectException will be thrown. * larger than this limit, LargeObjectException will be thrown.
* @return if a note is defined for {@code id}, the note content. If no note * @return if a note is defined for {@code id}, the note content. If no note
* is defined, null. * is defined, null.
* @throws LargeObjectException * @throws org.eclipse.jgit.errors.LargeObjectException
* the note data is larger than {@code sizeLimit}. * the note data is larger than {@code sizeLimit}.
* @throws MissingObjectException * @throws org.eclipse.jgit.errors.MissingObjectException
* the note's blob does not exist in the repository. * the note's blob does not exist in the repository.
* @throws IOException * @throws java.io.IOException
* the note's blob cannot be read from the repository * the note's blob cannot be read from the repository
*/ */
public byte[] getCachedBytes(AnyObjectId id, int sizeLimit) public byte[] getCachedBytes(AnyObjectId id, int sizeLimit)
@ -306,7 +305,7 @@ public class NoteMap implements Iterable<Note> {
* data to associate with the note. This must be the ObjectId of * data to associate with the note. This must be the ObjectId of
* a blob that already exists in the repository. If null the note * a blob that already exists in the repository. If null the note
* will be deleted, if present. * will be deleted, if present.
* @throws IOException * @throws java.io.IOException
* a portion of the note space is not accessible. * a portion of the note space is not accessible.
*/ */
public void set(AnyObjectId noteOn, ObjectId noteData) throws IOException { public void set(AnyObjectId noteOn, ObjectId noteData) throws IOException {
@ -337,7 +336,7 @@ public class NoteMap implements Iterable<Note> {
* inserter to write the encoded {@code noteData} out as a blob. * inserter to write the encoded {@code noteData} out as a blob.
* The caller must ensure the inserter is flushed before the * The caller must ensure the inserter is flushed before the
* updated note map is made available for reading. * updated note map is made available for reading.
* @throws IOException * @throws java.io.IOException
* the note data could not be stored in the repository. * the note data could not be stored in the repository.
*/ */
public void set(AnyObjectId noteOn, String noteData, ObjectInserter ins) public void set(AnyObjectId noteOn, String noteData, ObjectInserter ins)
@ -361,7 +360,7 @@ public class NoteMap implements Iterable<Note> {
* *
* @param noteOn * @param noteOn
* the object to remove the note from. * the object to remove the note from.
* @throws IOException * @throws java.io.IOException
* a portion of the note space is not accessible. * a portion of the note space is not accessible.
*/ */
public void remove(AnyObjectId noteOn) throws IOException { public void remove(AnyObjectId noteOn) throws IOException {
@ -376,7 +375,7 @@ public class NoteMap implements Iterable<Note> {
* Caller is responsible for flushing the inserter before trying * Caller is responsible for flushing the inserter before trying
* to read the objects, or exposing them through a reference. * to read the objects, or exposing them through a reference.
* @return the top level tree. * @return the top level tree.
* @throws IOException * @throws java.io.IOException
* a tree could not be written. * a tree could not be written.
*/ */
public ObjectId writeTree(ObjectInserter inserter) throws IOException { public ObjectId writeTree(ObjectInserter inserter) throws IOException {

19
org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMapMerger.java
Unescape View File

@ -62,8 +62,9 @@ import org.eclipse.jgit.treewalk.TreeWalk;
/** /**
* Three-way note tree merge. * Three-way note tree merge.
* <p> * <p>
* Direct implementation of NoteMap merger without using {@link TreeWalk} and * Direct implementation of NoteMap merger without using
* {@link AbstractTreeIterator} * {@link org.eclipse.jgit.treewalk.TreeWalk} and
* {@link org.eclipse.jgit.treewalk.AbstractTreeIterator}
*/ */
public class NoteMapMerger { public class NoteMapMerger {
private static final FanoutBucket EMPTY_FANOUT = new FanoutBucket(0); private static final FanoutBucket EMPTY_FANOUT = new FanoutBucket(0);
@ -83,8 +84,9 @@ public class NoteMapMerger {
private final MutableObjectId objectIdPrefix; private final MutableObjectId objectIdPrefix;
/** /**
* Constructs a NoteMapMerger with custom {@link NoteMerger} and custom * Constructs a NoteMapMerger with custom
* {@link MergeStrategy}. * {@link org.eclipse.jgit.notes.NoteMerger} and custom
* {@link org.eclipse.jgit.merge.MergeStrategy}.
* *
* @param db * @param db
* Git repository * Git repository
@ -104,9 +106,10 @@ public class NoteMapMerger {
} }
/** /**
* Constructs a NoteMapMerger with {@link DefaultNoteMerger} as the merger * Constructs a NoteMapMerger with
* for notes and the {@link MergeStrategy#RESOLVE} as the strategy for * {@link org.eclipse.jgit.notes.DefaultNoteMerger} as the merger for notes
* resolving conflicts on non-notes * and the {@link org.eclipse.jgit.merge.MergeStrategy#RESOLVE} as the
* strategy for resolving conflicts on non-notes
* *
* @param db * @param db
* Git repository * Git repository
@ -125,7 +128,7 @@ public class NoteMapMerger {
* @param theirs * @param theirs
* theirs version of the note tree * theirs version of the note tree
* @return merge result as a new NoteMap * @return merge result as a new NoteMap
* @throws IOException * @throws java.io.IOException
*/ */
public NoteMap merge(NoteMap base, NoteMap ours, NoteMap theirs) public NoteMap merge(NoteMap base, NoteMap ours, NoteMap theirs)
throws IOException { throws IOException {

10
org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMerger.java
Unescape View File

@ -72,13 +72,13 @@ public interface NoteMerger {
* @param inserter * @param inserter
* the object inserter that must be used to insert Git objects * the object inserter that must be used to insert Git objects
* @return the merge result * @return the merge result
* @throws NotesMergeConflictException * @throws org.eclipse.jgit.notes.NotesMergeConflictException
* in case there was a merge conflict which this note merger * in case there was a merge conflict which this note merger
* couldn't resolve * couldn't resolve
* @throws IOException * @throws java.io.IOException
* in case the reader or the inserter would throw an IOException * in case the reader or the inserter would throw an
* the implementor will most likely want to propagate it as it * java.io.IOException the implementor will most likely want to
* can't do much to recover from it * propagate it as it can't do much to recover from it
*/ */
Note merge(Note base, Note ours, Note their, ObjectReader reader, Note merge(Note base, Note ours, Note their, ObjectReader reader,
ObjectInserter inserter) throws NotesMergeConflictException, ObjectInserter inserter) throws NotesMergeConflictException,

5
org.eclipse.jgit/src/org/eclipse/jgit/notes/NotesMergeConflictException.java
Unescape View File

@ -49,8 +49,9 @@ import java.text.MessageFormat;
import org.eclipse.jgit.internal.JGitText; import org.eclipse.jgit.internal.JGitText;
/** /**
* This exception will be thrown from the {@link NoteMerger} when a conflict on * This exception will be thrown from the
* Notes content is found during merge. * {@link org.eclipse.jgit.notes.NoteMerger} when a conflict on Notes content is
* found during merge.
*/ */
public class NotesMergeConflictException extends IOException { public class NotesMergeConflictException extends IOException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

Write Preview
Loading…
Cancel
Save