motiejus
/
jgit
1
Fork 0
Code Releases Activity

Fix javadoc in org.eclipse.jgit.archive 

Change-Id: Ibef80b15f17e884f3085e324283cefc738236a4d
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
This commit is contained in:
Matthias Sohn 2017-12-17 00:01:03 +01:00
parent c7093f5cbe
commit 32022e9764
8 changed files with 45 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ArchiveFormats.java
View File

@ -48,11 +48,11 @@
import org.eclipse.jgit.api.ArchiveCommand; import org.eclipse.jgit.api.ArchiveCommand;
/** /**
* Registers all format types from the org.eclipse.jgit.archive * Registers all format types from the org.eclipse.jgit.archive package for use
* package for use via the ArchiveCommand API. * via the ArchiveCommand API.
* *
* See {@link FormatActivator} for an OSGi bundle activator * See {@link org.eclipse.jgit.archive.FormatActivator} for an OSGi bundle
* that performs the same registration automatically. * activator that performs the same registration automatically.
*/ */
public class ArchiveFormats { public class ArchiveFormats {
private static final List<String> myFormats = new ArrayList<>(); private static final List<String> myFormats = new ArrayList<>();

10
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java
View File

@ -57,12 +57,11 @@
*/ */
public class FormatActivator implements BundleActivator { public class FormatActivator implements BundleActivator {
/** /**
* {@inheritDoc}
*
* Registers all included archive formats by calling * Registers all included archive formats by calling
* {@link ArchiveFormats#registerAll()}. This method is called by the OSGi * {@link ArchiveFormats#registerAll()}. This method is called by the OSGi
* framework when the bundle is started. * framework when the bundle is started.
*
* @param context
* unused
*/ */
@Override @Override
public void start(BundleContext context) { public void start(BundleContext context) {
@ -70,11 +69,10 @@ public void start(BundleContext context) {
} }
/** /**
* {@inheritDoc}
*
* Cleans up after {@link #start(BundleContext)} by calling * Cleans up after {@link #start(BundleContext)} by calling
* {@link ArchiveFormats#unregisterAll}. * {@link ArchiveFormats#unregisterAll}.
*
* @param context
* unused
*/ */
@Override @Override
public void stop(BundleContext context) { public void stop(BundleContext context) {

13
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java
View File

@ -70,6 +70,7 @@ public final class TarFormat extends BaseFormat implements
private static final List<String> SUFFIXES = Collections private static final List<String> SUFFIXES = Collections
.unmodifiableList(Arrays.asList(".tar")); //$NON-NLS-1$ .unmodifiableList(Arrays.asList(".tar")); //$NON-NLS-1$
/** {@inheritDoc} */
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s) public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
throws IOException { throws IOException {
@ -77,9 +78,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
Collections.<String, Object> emptyMap()); Collections.<String, Object> emptyMap());
} }
/** /** {@inheritDoc} */
* @since 4.0
*/
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s, public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
Map<String, Object> o) throws IOException { Map<String, Object> o) throws IOException {
@ -89,6 +88,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
return applyFormatOptions(out, o); return applyFormatOptions(out, o);
} }
/** {@inheritDoc} */
@Deprecated @Deprecated
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
@ -97,9 +97,7 @@ public void putEntry(ArchiveOutputStream out,
putEntry(out, null, path, mode,loader); putEntry(out, null, path, mode,loader);
} }
/** /** {@inheritDoc} */
* @since 4.7
*/
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
ObjectId tree, String path, FileMode mode, ObjectLoader loader) ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@ -150,16 +148,19 @@ public void putEntry(ArchiveOutputStream out,
out.closeArchiveEntry(); out.closeArchiveEntry();
} }
/** {@inheritDoc} */
@Override @Override
public Iterable<String> suffixes() { public Iterable<String> suffixes() {
return SUFFIXES; return SUFFIXES;
} }
/** {@inheritDoc} */
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (other instanceof TarFormat); return (other instanceof TarFormat);
} }
/** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return getClass().hashCode(); return getClass().hashCode();

13
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/Tbz2Format.java
View File

@ -66,6 +66,7 @@ public final class Tbz2Format extends BaseFormat implements
private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat(); private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
/** {@inheritDoc} */
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s) public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
throws IOException { throws IOException {
@ -73,9 +74,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
Collections.<String, Object> emptyMap()); Collections.<String, Object> emptyMap());
} }
/** /** {@inheritDoc} */
* @since 4.0
*/
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s, public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
Map<String, Object> o) throws IOException { Map<String, Object> o) throws IOException {
@ -83,6 +82,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
return tarFormat.createArchiveOutputStream(out, o); return tarFormat.createArchiveOutputStream(out, o);
} }
/** {@inheritDoc} */
@Deprecated @Deprecated
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
@ -91,9 +91,7 @@ public void putEntry(ArchiveOutputStream out,
putEntry(out, null, path, mode,loader); putEntry(out, null, path, mode,loader);
} }
/** /** {@inheritDoc} */
* @since 4.7
*/
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
ObjectId tree, String path, FileMode mode, ObjectLoader loader) ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@ -101,16 +99,19 @@ public void putEntry(ArchiveOutputStream out,
tarFormat.putEntry(out, tree, path, mode, loader); tarFormat.putEntry(out, tree, path, mode, loader);
} }
/** {@inheritDoc} */
@Override @Override
public Iterable<String> suffixes() { public Iterable<String> suffixes() {
return SUFFIXES; return SUFFIXES;
} }
/** {@inheritDoc} */
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (other instanceof Tbz2Format); return (other instanceof Tbz2Format);
} }
/** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return getClass().hashCode(); return getClass().hashCode();

13
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java
View File

@ -66,6 +66,7 @@ public final class TgzFormat extends BaseFormat implements
private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat(); private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
/** {@inheritDoc} */
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s) public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
throws IOException { throws IOException {
@ -73,9 +74,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
Collections.<String, Object> emptyMap()); Collections.<String, Object> emptyMap());
} }
/** /** {@inheritDoc} */
* @since 4.0
*/
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s, public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
Map<String, Object> o) throws IOException { Map<String, Object> o) throws IOException {
@ -83,6 +82,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
return tarFormat.createArchiveOutputStream(out, o); return tarFormat.createArchiveOutputStream(out, o);
} }
/** {@inheritDoc} */
@Deprecated @Deprecated
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
@ -91,9 +91,7 @@ public void putEntry(ArchiveOutputStream out,
putEntry(out, null, path, mode,loader); putEntry(out, null, path, mode,loader);
} }
/** /** {@inheritDoc} */
* @since 4.7
*/
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
ObjectId tree, String path, FileMode mode, ObjectLoader loader) ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@ -101,16 +99,19 @@ public void putEntry(ArchiveOutputStream out,
tarFormat.putEntry(out, tree, path, mode, loader); tarFormat.putEntry(out, tree, path, mode, loader);
} }
/** {@inheritDoc} */
@Override @Override
public Iterable<String> suffixes() { public Iterable<String> suffixes() {
return SUFFIXES; return SUFFIXES;
} }
/** {@inheritDoc} */
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (other instanceof TgzFormat); return (other instanceof TgzFormat);
} }
/** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return getClass().hashCode(); return getClass().hashCode();

13
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java
View File

@ -66,6 +66,7 @@ public final class TxzFormat extends BaseFormat implements
private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat(); private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
/** {@inheritDoc} */
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s) public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
throws IOException { throws IOException {
@ -73,9 +74,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
Collections.<String, Object> emptyMap()); Collections.<String, Object> emptyMap());
} }
/** /** {@inheritDoc} */
* @since 4.0
*/
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s, public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
Map<String, Object> o) throws IOException { Map<String, Object> o) throws IOException {
@ -83,6 +82,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
return tarFormat.createArchiveOutputStream(out, o); return tarFormat.createArchiveOutputStream(out, o);
} }
/** {@inheritDoc} */
@Deprecated @Deprecated
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
@ -91,9 +91,7 @@ public void putEntry(ArchiveOutputStream out,
putEntry(out, null, path, mode,loader); putEntry(out, null, path, mode,loader);
} }
/** /** {@inheritDoc} */
* @since 4.7
*/
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
ObjectId tree, String path, FileMode mode, ObjectLoader loader) ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@ -101,16 +99,19 @@ public void putEntry(ArchiveOutputStream out,
tarFormat.putEntry(out, tree, path, mode, loader); tarFormat.putEntry(out, tree, path, mode, loader);
} }
/** {@inheritDoc} */
@Override @Override
public Iterable<String> suffixes() { public Iterable<String> suffixes() {
return SUFFIXES; return SUFFIXES;
} }
/** {@inheritDoc} */
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (other instanceof TxzFormat); return (other instanceof TxzFormat);
} }
/** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return getClass().hashCode(); return getClass().hashCode();

13
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java
View File

@ -68,6 +68,7 @@ public final class ZipFormat extends BaseFormat implements
private static final List<String> SUFFIXES = Collections private static final List<String> SUFFIXES = Collections
.unmodifiableList(Arrays.asList(".zip")); //$NON-NLS-1$ .unmodifiableList(Arrays.asList(".zip")); //$NON-NLS-1$
/** {@inheritDoc} */
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s) public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
throws IOException { throws IOException {
@ -75,15 +76,14 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
Collections.<String, Object> emptyMap()); Collections.<String, Object> emptyMap());
} }
/** /** {@inheritDoc} */
* @since 4.0
*/
@Override @Override
public ArchiveOutputStream createArchiveOutputStream(OutputStream s, public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
Map<String, Object> o) throws IOException { Map<String, Object> o) throws IOException {
return applyFormatOptions(new ZipArchiveOutputStream(s), o); return applyFormatOptions(new ZipArchiveOutputStream(s), o);
} }
/** {@inheritDoc} */
@Deprecated @Deprecated
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
@ -92,9 +92,7 @@ public void putEntry(ArchiveOutputStream out,
putEntry(out, null, path, mode,loader); putEntry(out, null, path, mode,loader);
} }
/** /** {@inheritDoc} */
* @since 4.7
*/
@Override @Override
public void putEntry(ArchiveOutputStream out, public void putEntry(ArchiveOutputStream out,
ObjectId tree, String path, FileMode mode, ObjectLoader loader) ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@ -136,16 +134,19 @@ public void putEntry(ArchiveOutputStream out,
out.closeArchiveEntry(); out.closeArchiveEntry();
} }
/** {@inheritDoc} */
@Override @Override
public Iterable<String> suffixes() { public Iterable<String> suffixes() {
return SUFFIXES; return SUFFIXES;
} }
/** {@inheritDoc} */
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (other instanceof ZipFormat); return (other instanceof ZipFormat);
} }
/** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return getClass().hashCode(); return getClass().hashCode();

2
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/internal/ArchiveText.java
View File

@ -51,6 +51,8 @@
*/ */
public class ArchiveText extends TranslationBundle { public class ArchiveText extends TranslationBundle {
/** /**
* Get an instance of this translation bundle.
*
* @return an instance of this translation bundle * @return an instance of this translation bundle
*/ */
public static ArchiveText get() { public static ArchiveText get() {