123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274 |
- /*
- * Copyright (C) 2010, Google Inc.
- * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org> and others
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Distribution License v. 1.0 which is available at
- * https://www.eclipse.org/org/documents/edl-v10.php.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- */
-
- package org.eclipse.jgit.lib;
-
- import org.eclipse.jgit.annotations.NonNull;
- import org.eclipse.jgit.annotations.Nullable;
-
- /**
- * A {@link org.eclipse.jgit.lib.Ref} that points directly at an
- * {@link org.eclipse.jgit.lib.ObjectId}.
- */
- public abstract class ObjectIdRef implements Ref {
- /** Any reference whose peeled value is not yet known. */
- public static class Unpeeled extends ObjectIdRef {
- /**
- * Create a new ref pairing.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref. May be {@code null} to indicate
- * a ref that does not exist yet.
- */
- public Unpeeled(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id) {
- super(st, name, id, UNDEFINED_UPDATE_INDEX);
- }
-
- /**
- * Create a new ref pairing with update index.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref. May be {@code null} to indicate
- * a ref that does not exist yet.
- * @param updateIndex
- * number increasing with each update to the reference.
- * @since 5.3
- */
- public Unpeeled(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id, long updateIndex) {
- super(st, name, id, updateIndex);
- }
-
- @Override
- @Nullable
- public ObjectId getPeeledObjectId() {
- return null;
- }
-
- @Override
- public boolean isPeeled() {
- return false;
- }
- }
-
- /** An annotated tag whose peeled object has been cached. */
- public static class PeeledTag extends ObjectIdRef {
- private final ObjectId peeledObjectId;
-
- /**
- * Create a new ref pairing.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref.
- * @param p
- * the first non-tag object that tag {@code id} points to.
- */
- public PeeledTag(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id, @NonNull ObjectId p) {
- super(st, name, id, UNDEFINED_UPDATE_INDEX);
- peeledObjectId = p;
- }
-
- /**
- * Create a new ref pairing with update index.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref. May be {@code null} to indicate
- * a ref that does not exist yet.
- * @param p
- * the first non-tag object that tag {@code id} points to.
- * @param updateIndex
- * number increasing with each update to the reference.
- * @since 5.3
- */
- public PeeledTag(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id, @NonNull ObjectId p, long updateIndex) {
- super(st, name, id, updateIndex);
- peeledObjectId = p;
- }
-
- @Override
- @NonNull
- public ObjectId getPeeledObjectId() {
- return peeledObjectId;
- }
-
- @Override
- public boolean isPeeled() {
- return true;
- }
- }
-
- /** A reference to a non-tag object coming from a cached source. */
- public static class PeeledNonTag extends ObjectIdRef {
- /**
- * Create a new ref pairing.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref. May be {@code null} to indicate
- * a ref that does not exist yet.
- */
- public PeeledNonTag(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id) {
- super(st, name, id, UNDEFINED_UPDATE_INDEX);
- }
-
- /**
- * Create a new ref pairing with update index.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref. May be {@code null} to indicate
- * a ref that does not exist yet.
- * @param updateIndex
- * number increasing with each update to the reference.
- * @since 5.3
- */
- public PeeledNonTag(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id, long updateIndex) {
- super(st, name, id, updateIndex);
- }
-
- @Override
- @Nullable
- public ObjectId getPeeledObjectId() {
- return null;
- }
-
- @Override
- public boolean isPeeled() {
- return true;
- }
- }
-
- private final String name;
-
- private final Storage storage;
-
- private final ObjectId objectId;
-
- private final long updateIndex;
-
- /**
- * Create a new ref pairing.
- *
- * @param st
- * method used to store this ref.
- * @param name
- * name of this ref.
- * @param id
- * current value of the ref. May be {@code null} to indicate a
- * ref that does not exist yet.
- * @param updateIndex
- * number that increases with each ref update. Set to -1 if the
- * storage doesn't support versioning.
- * @since 5.3
- */
- protected ObjectIdRef(@NonNull Storage st, @NonNull String name,
- @Nullable ObjectId id, long updateIndex) {
- this.name = name;
- this.storage = st;
- this.objectId = id;
- this.updateIndex = updateIndex;
- }
-
- /** {@inheritDoc} */
- @Override
- @NonNull
- public String getName() {
- return name;
- }
-
- /** {@inheritDoc} */
- @Override
- public boolean isSymbolic() {
- return false;
- }
-
- /** {@inheritDoc} */
- @Override
- @NonNull
- public Ref getLeaf() {
- return this;
- }
-
- /** {@inheritDoc} */
- @Override
- @NonNull
- public Ref getTarget() {
- return this;
- }
-
- /** {@inheritDoc} */
- @Override
- @Nullable
- public ObjectId getObjectId() {
- return objectId;
- }
-
- /** {@inheritDoc} */
- @Override
- @NonNull
- public Storage getStorage() {
- return storage;
- }
-
- /**
- * {@inheritDoc}
- * @since 5.3
- */
- @Override
- public long getUpdateIndex() {
- if (updateIndex == UNDEFINED_UPDATE_INDEX) {
- throw new UnsupportedOperationException();
- }
- return updateIndex;
- }
-
- /** {@inheritDoc} */
- @NonNull
- @Override
- public String toString() {
- StringBuilder r = new StringBuilder();
- r.append("Ref["); //$NON-NLS-1$
- r.append(getName());
- r.append('=');
- r.append(ObjectId.toString(getObjectId()));
- r.append('(');
- r.append(updateIndex); // Print value, even if -1
- r.append(")]"); //$NON-NLS-1$
- return r.toString();
- }
- }
|