Uses of Annotation Interface
org.eclipse.jgit.annotations.Nullable
Packages that use Nullable
Package
Description
High-level API commands (the porcelain of JGit).
Exceptions thrown by API commands.
Support for reading .gitattributes.
Computing blame/annotate information of files.
Exceptions thrown by lower-level JGit APIs.
Ignore rule parser/matcher (for .gitignore entries).
Git fsck support.
Distributed file system based repository storage.
File based repository storage.
Reading/writing Git pack files.
Core API for repository, config, refs, object database.
Content and commit history merge algorithms.
Walking revision graphs (commit history).
Transport (fetch/push) for different protocols.
Walking and comparing directory/file trees (of commits, file system).
Filters for use in tree walking.
Utility classes.
-
Uses of Nullable in org.eclipse.jgit.api
Method parameters in org.eclipse.jgit.api with annotations of type NullableModifier and TypeMethodDescriptionMergeCommand.setFastForward(MergeCommand.FastForwardMode fastForwardMode) Sets the fast forward mode.PullCommand.setFastForward(MergeCommand.FastForwardMode fastForwardMode) Set the fast forward mode.FetchCommand.setRecurseSubmodules(SubmoduleConfig.FetchRecurseSubmodulesMode recurse) Set the mode to be used for recursing into submodules.PullCommand.setRecurseSubmodules(SubmoduleConfig.FetchRecurseSubmodulesMode recurse) Set the mode to be used for recursing into submodules. -
Uses of Nullable in org.eclipse.jgit.api.errors
Methods in org.eclipse.jgit.api.errors with annotations of type NullableModifier and TypeMethodDescriptionRefAlreadyExistsException.getUpdateResult()Retrieves theRefUpdate.Resultthat caused the exception.Constructor parameters in org.eclipse.jgit.api.errors with annotations of type NullableModifierConstructorDescriptionRefAlreadyExistsException(String message, RefUpdate.Result updateResult) Constructor for RefAlreadyExistsException -
Uses of Nullable in org.eclipse.jgit.attributes
Methods in org.eclipse.jgit.attributes with annotations of type NullableMethod parameters in org.eclipse.jgit.attributes with annotations of type NullableModifier and TypeMethodDescriptionprotected voidAttributesHandler.mergeAttributes(AttributesNode node, String entryPath, boolean isDirectory, Attributes result) Merges the matching node attributes for an entry path. -
Uses of Nullable in org.eclipse.jgit.blame
Methods in org.eclipse.jgit.blame with annotations of type NullableModifier and TypeMethodDescriptionBlameGenerator.getRenameDetector()Obtain the RenameDetector, allowing the application to configure its settings for rename score and breaking behavior.Constructor parameters in org.eclipse.jgit.blame with annotations of type NullableModifierConstructorDescriptionBlameGenerator(Repository repository, String path, BlameCache blameCache) Create a blame generator for the repository and path (relative to repository) -
Uses of Nullable in org.eclipse.jgit.errors
Methods in org.eclipse.jgit.errors with annotations of type NullableModifier and TypeMethodDescriptionCorruptObjectException.getErrorType()Specific error condition identified byObjectChecker.CorruptPackIndexException.getErrorType()Specific the reason of the corrupt index file. -
Uses of Nullable in org.eclipse.jgit.gitrepo
Methods in org.eclipse.jgit.gitrepo with annotations of type Nullable -
Uses of Nullable in org.eclipse.jgit.ignore
Methods in org.eclipse.jgit.ignore with annotations of type NullableModifier and TypeMethodDescriptionIgnoreNode.checkIgnored(String entryPath, boolean isDirectory) Determine if an entry path matches an ignore rule. -
Uses of Nullable in org.eclipse.jgit.internal.fsck
Methods in org.eclipse.jgit.internal.fsck with annotations of type NullableConstructor parameters in org.eclipse.jgit.internal.fsck with annotations of type NullableModifierConstructorDescriptionCorruptObject(ObjectId id, int type, ObjectChecker.ErrorType errorType) -
Uses of Nullable in org.eclipse.jgit.internal.storage.dfs
Methods in org.eclipse.jgit.internal.storage.dfs with annotations of type NullableMethod parameters in org.eclipse.jgit.internal.storage.dfs with annotations of type NullableModifier and TypeMethodDescriptionprotected booleanDfsReftableDatabase.compareAndPut(Ref oldRef, Ref newRef) static DfsStreamKeyDfsStreamKey.of(DfsRepositoryDescription repo, String name, PackExt ext) Create aDfsStreamKeyvoidInMemoryRepository.setGitwebDescription(String d) Constructor parameters in org.eclipse.jgit.internal.storage.dfs with annotations of type NullableModifierConstructorDescriptionprotectedDfsStreamKey(int hash, PackExt ext) Constructor for DfsStreamKey. -
Uses of Nullable in org.eclipse.jgit.internal.storage.file
Methods in org.eclipse.jgit.internal.storage.file with annotations of type NullableModifier and TypeMethodDescriptionRefDirectory.firstExactRef(String... refs) FileRepository.getGitwebDescription()Method parameters in org.eclipse.jgit.internal.storage.file with annotations of type NullableConstructor parameters in org.eclipse.jgit.internal.storage.file with annotations of type NullableModifierConstructorDescriptionFileReftableStack(File reftableDir, Runnable onChange, Supplier<Config> configSupplier) Creates a stack corresponding to the list of reftables in the argumentConstruct a reader for an existing, pre-indexed packfile. -
Uses of Nullable in org.eclipse.jgit.internal.storage.memory
Methods in org.eclipse.jgit.internal.storage.memory with annotations of type Nullable -
Uses of Nullable in org.eclipse.jgit.internal.storage.pack
Methods in org.eclipse.jgit.internal.storage.pack with annotations of type NullableModifier and TypeMethodDescriptionCachedPackUriProvider.getInfo(CachedPack pack, Collection<String> protocolsSupported) Get pack infoConstructor parameters in org.eclipse.jgit.internal.storage.pack with annotations of type NullableModifierConstructorDescriptionPackWriter(PackConfig config, ObjectReader reader, PackStatistics.Accumulator statsAccumulator) Create writer with a specified configuration. -
Uses of Nullable in org.eclipse.jgit.internal.storage.reftable
Methods in org.eclipse.jgit.internal.storage.reftable with annotations of type NullableModifier and TypeMethodDescriptionLookup a reference, or null if not found.Read a single reference.abstract ReflogEntryLogCursor.getReflogEntry()Get current log entry.Resolve a symbolic reference to populate its value.Method parameters in org.eclipse.jgit.internal.storage.reftable with annotations of type Nullable -
Uses of Nullable in org.eclipse.jgit.internal.transport.parser
Methods in org.eclipse.jgit.internal.transport.parser with annotations of type NullableModifier and TypeMethodDescriptionFirstWant.getAgent()Get agentFirstWant.getClientSID()Get client session-id -
Uses of Nullable in org.eclipse.jgit.lib
Methods in org.eclipse.jgit.lib with annotations of type NullableModifier and TypeMethodDescriptionabstract RefRead a single reference.final RefGet a ref by name.final RefRead a single reference.static RefTry to find the specified name in the ref map usingRefDatabase.SEARCH_PATH.final RefSearch for a ref by (possibly abbreviated) name.RefDatabase.firstExactRef(String... refs) Find the first named reference.Config.getBoolean(String section, String name) Get a boolean value from the git configConfig.getBoolean(String section, String subsection, String name) Get a boolean value from the git configDefaultTypedConfigGetter.getBoolean(Config config, String section, String subsection, String name, Boolean defaultValue) TypedConfigGetter.getBoolean(Config config, String section, String subsection, String name, Boolean defaultValue) Get a boolean value from a gitConfig.Repository.getBranch()Get the short name of the current branch thatHEADpoints to.CommitConfig.getCommitEncoding()Get the encoding of the commit as defined in the giti18n.commitEncodingproperty.CommitConfig.getCommitTemplateContent(Repository repository) Get the content to the commit template as defined incommit.template.CommitConfig.getCommitTemplatePath()Get the path to the commit template as defined in the gitcommit.templateproperty.ObjectReader.Filter.getCreatedFromInserter()ObjectReader.getCreatedFromInserter()Get theObjectInserterfrom which this reader was created usinginserter.newReader()<T extends Enum<?>>
TParse an enumeration from the configuration.<T extends Enum<?>>
TDeprecated.<T extends Enum<?>>
TDefaultTypedConfigGetter.getEnum(Config config, T[] all, String section, String subsection, String name, T defaultValue) <T extends Enum<?>>
TTypedConfigGetter.getEnum(Config config, T[] all, String section, String subsection, String name, T defaultValue) Parse an enumeration from a gitConfig.static GpgConfig.GpgFormatSignatureVerifiers.getFormat(byte[] signature) Determines the type of a given signature.Repository.getFullBranch()Get the name of the reference thatHEADpoints to.Repository.getGitwebDescription()Read theGIT_DIR/descriptionfile for gitweb.ObjectBuilder.getGpgSignature()Retrieves the GPG signature of this object.Obtain an integer value from the configuration.Obtain an integer value from the configuration.DefaultTypedConfigGetter.getInt(Config config, String section, String subsection, String name, Integer defaultValue) TypedConfigGetter.getInt(Config config, String section, String subsection, String name, Integer defaultValue) Obtain an integer value from a gitConfig.Config.getIntInRange(String section, String name, int minValue, int maxValue) Obtain an integer value from the configuration which must be inside given range.Config.getIntInRange(String section, String subsection, String name, int minValue, int maxValue) Obtain an integer value from the configuration which must be inside given range.TypedConfigGetter.getIntInRange(Config config, String section, String subsection, String name, int minValue, int maxValue, Integer defaultValue) Obtain an integer value from a gitConfigwhich must be in given range.Obtain an integer value from the configuration.Obtain an integer value from the configuration.DefaultTypedConfigGetter.getLong(Config config, String section, String subsection, String name, Long defaultValue) TypedConfigGetter.getLong(Config config, String section, String subsection, String name, Long defaultValue) Obtain a long value from a gitConfig.ObjectBuilder.getMessage()Retrieves the complete message of the object.ObjectIdRef.getObjectId()Ref.getObjectId()Cached value of this ref.SymbolicRef.getObjectId()Config.getPath(String section, String subsection, String name, FS fs, File resolveAgainst, Path defaultValue) Parse a string value and treat it as a file path, replacing a ~/ prefix by the user's home directory.default PathTypedConfigGetter.getPath(Config config, String section, String subsection, String name, FS fs, File resolveAgainst, Path defaultValue) Parse a string value from a gitConfigand treat it as a file path, replacing a ~/ prefix by the user's home directory.ObjectIdRef.PeeledNonTag.getPeeledObjectId()ObjectIdRef.Unpeeled.getPeeledObjectId()Ref.getPeeledObjectId()Cached value ofref^{}(the ref peeled to commit).SymbolicRef.getPeeledObjectId()BatchRefUpdate.getPushOptions()Gets the list of option strings associated with this update.BatchRefUpdate.getRefLogMessage()Get the message to include in the reflog.RefDatabase.getReflogReader(String refName) Get the reflog readerRepository.getReflogReader(String refName) Deprecated.use#getRefDatabase().getReflogReader(String)insteadRepository.getRemoteName(String refName) Get remote nameGet string value or null if not found.Config.getTimeUnit(String section, String subsection, String name, TimeUnit wantUnit) Parse a numerical time unit, such as "1 minute", from the configuration.TypedConfigGetter.getTimeUnit(Config config, String section, String subsection, String name, Long defaultValue, TimeUnit wantUnit) Parse a numerical time unit, such as "1 minute", from a gitConfig.ObjectChecker.newBlobObjectChecker()Create a newBlobObjectChecker.static ObjectIdObjectIdSerializer.read(InputStream in) Read a possibly nullObjectIdfrom the stream.Repository.readCherryPickHead()Return the information stored in the file $GIT_DIR/CHERRY_PICK_HEAD.Repository.readCommitEditMsg()Return the information stored in the file $GIT_DIR/COMMIT_EDITMSG.Repository.readMergeCommitMsg()Return the information stored in the file $GIT_DIR/MERGE_MSG.Repository.readMergeHeads()Return the information stored in the file $GIT_DIR/MERGE_HEAD.Repository.readOrigHead()Return the information stored in the file $GIT_DIR/ORIG_HEAD.Repository.readRevertHead()Return the information stored in the file $GIT_DIR/REVERT_HEAD.Repository.readSquashCommitMsg()Return the information stored in the file $GIT_DIR/SQUASH_MSG.Parse a git revision string and return an object id.Repository.shortenRemoteBranchName(String refName) Get a shortened more user friendly remote tracking branch nameSimplify an expression, but unlikeRepository.resolve(String)it will not resolve a branch passed or resulting from the expression, such as @{-}.SignatureVerifiers.verify(Repository repository, GpgConfig config, byte[] data, byte[] signature) Verifies a given signature for some give data.SignatureVerifiers.verify(Repository repository, GpgConfig config, RevObject object) Verifies the signature on a signed commit or tag.Method parameters in org.eclipse.jgit.lib with annotations of type NullableModifier and TypeMethodDescriptionvoidObjectChecker.check(AnyObjectId id, int objType, byte[] raw) Check an object for parsing errors.voidObjectChecker.checkCommit(AnyObjectId id, byte[] raw) Check a commit for errors.voidObjectChecker.checkTag(AnyObjectId id, byte[] raw) Check an annotated tag for errors.voidObjectChecker.checkTree(AnyObjectId id, byte[] raw) Check a canonical formatted tree for errors.DefaultTypedConfigGetter.getBoolean(Config config, String section, String subsection, String name, Boolean defaultValue) TypedConfigGetter.getBoolean(Config config, String section, String subsection, String name, Boolean defaultValue) Get a boolean value from a gitConfig.<T extends Enum<?>>
TDeprecated.<T extends Enum<?>>
TDefaultTypedConfigGetter.getEnum(Config config, T[] all, String section, String subsection, String name, T defaultValue) <T extends Enum<?>>
TTypedConfigGetter.getEnum(Config config, T[] all, String section, String subsection, String name, T defaultValue) Parse an enumeration from a gitConfig.DefaultTypedConfigGetter.getInt(Config config, String section, String subsection, String name, Integer defaultValue) TypedConfigGetter.getInt(Config config, String section, String subsection, String name, Integer defaultValue) Obtain an integer value from a gitConfig.TypedConfigGetter.getIntInRange(Config config, String section, String subsection, String name, int minValue, int maxValue, Integer defaultValue) Obtain an integer value from a gitConfigwhich must be in given range.DefaultTypedConfigGetter.getLong(Config config, String section, String subsection, String name, Long defaultValue) TypedConfigGetter.getLong(Config config, String section, String subsection, String name, Long defaultValue) Obtain a long value from a gitConfig.Config.getPath(String section, String subsection, String name, FS fs, File resolveAgainst, Path defaultValue) Parse a string value and treat it as a file path, replacing a ~/ prefix by the user's home directory.default PathTypedConfigGetter.getPath(Config config, String section, String subsection, String name, FS fs, File resolveAgainst, Path defaultValue) Parse a string value from a gitConfigand treat it as a file path, replacing a ~/ prefix by the user's home directory.DefaultTypedConfigGetter.getTimeUnit(Config config, String section, String subsection, String name, Long defaultValue, TimeUnit wantUnit) TypedConfigGetter.getTimeUnit(Config config, String section, String subsection, String name, Long defaultValue, TimeUnit wantUnit) Parse a numerical time unit, such as "1 minute", from a gitConfig.static final booleanTest a string of characters to verify it is a hex format.voidRepository.setGitwebDescription(String description) Set theGIT_DIR/descriptionfile for gitweb.voidObjectBuilder.setGpgSignature(GpgSignature gpgSignature) Sets the GPG signature of this object.ObjectChecker.setIgnore(Set<ObjectChecker.ErrorType> ids) Configure error types to be ignored across all objects.voidObjectBuilder.setMessage(String message) Sets the message (commit message, or message of an annotated tag).ObjectChecker.setSkipList(ObjectIdSet objects) Enable accepting specific malformed (but not horribly broken) objects.static voidObjectIdSerializer.write(OutputStream out, AnyObjectId id) Write a possibly nullObjectIdto the stream, using markers to differentiate null and non-null instances.Constructor parameters in org.eclipse.jgit.lib with annotations of type NullableModifierConstructorDescriptionprotectedObjectIdRef(Ref.Storage st, String name, ObjectId id, long updateIndex) Create a new ref pairing.PeeledNonTag(Ref.Storage st, String name, ObjectId id) Create a new ref pairing.PeeledNonTag(Ref.Storage st, String name, ObjectId id, long updateIndex) Create a new ref pairing with update index.PeeledTag(Ref.Storage st, String name, ObjectId id, ObjectId p) Create a new ref pairing.PeeledTag(Ref.Storage st, String name, ObjectId id, ObjectId p, long updateIndex) Create a new ref pairing with update index.Unpeeled(Ref.Storage st, String name, ObjectId id) Create a new ref pairing.Unpeeled(Ref.Storage st, String name, ObjectId id, long updateIndex) Create a new ref pairing with update index. -
Uses of Nullable in org.eclipse.jgit.merge
Fields in org.eclipse.jgit.merge with annotations of type NullableModifier and TypeFieldDescriptionprotected final RepositoryMerger.dbThe repository this merger operates on.Methods in org.eclipse.jgit.merge with annotations of type NullableModifier and TypeMethodDescriptionMerger.getRepository()Get the repository this merger operates on. -
Uses of Nullable in org.eclipse.jgit.revwalk
Methods in org.eclipse.jgit.revwalk with annotations of type NullableModifier and TypeMethodDescriptionfinal StringRevCommit.getEncodingName()Determine the encoding of the commit message buffer.final byte[]RevTag.getRawGpgSignature()Parse the GPG signature from the raw buffer.DateRevQueue.peek()Peek at the next commit, without removing it. -
Uses of Nullable in org.eclipse.jgit.transport
Methods in org.eclipse.jgit.transport with annotations of type NullableModifier and TypeMethodDescriptionFilterSpec.filterLine()Get filter line describing this specLsRefsV2Request.getAgent()Get agent reported by the clientLsRefsV2Request.getClientSID()Get session-id reported by the clientUploadPack.getClientSID()Get the session ID if received from the client.ReceiveCommand.getNewSymref()Get requested new target for a symbolic reference.ReceiveCommand.getOldSymref()Get expected old target for a symbolic reference.ReceivePack.getPushOptions()Gets an unmodifiable view of the option strings associated with the push.ReceivePack.getReceivedPackStatistics()Returns the statistics on the received pack if available.ReceiveCommand.getRefLogMessage()Get the message to include in the reflog.ReceiveCommand.isForceRefLog()Check whether the reflog should be written regardless of repo defaults.TransferConfig.newObjectChecker()Create checker to verify fetched objectsTransferConfig.newReceiveObjectChecker()Create checker to verify objects pushed into this repositoryMethod parameters in org.eclipse.jgit.transport with annotations of type NullableModifier and TypeMethodDescriptionstatic ReceiveCommandCreate a command to switch a symbolic reference's target.voidUploadPack.sendAdvertisedRefs(RefAdvertiser adv, String serviceName) Generate an advertisement of available refs and capabilities.voidUploadPack.setAdvertisedRefs(Map<String, Ref> allRefs) Set the refs advertised by this UploadPack.voidUploadPack.setAdvertiseRefsHook(AdvertiseRefsHook advertiseRefsHook) Set the hook used while advertising the refs to the client.Value of an agent line received after the command and before the arguments.voidUploadPack.setCachedPackUriProvider(CachedPackUriProvider p) Set provider of cached pack URIsLsRefsV2Request.Builder.setClientSID(String value) Value of a session-id line received after the command and before the arguments.voidUploadPack.setPackConfig(PackConfig pc) Set the configuration used by the pack generator.voidUploadPack.setPostUploadHook(PostUploadHook hook) Set the hook for post upload actions (logging, repacking).voidUploadPack.setPreUploadHook(PreUploadHook hook) Set the hook that controls how this instance will behave.voidUploadPack.setProtocolV2Hook(ProtocolV2Hook hook) Set the protocol V2 hook.voidReceivePack.setPushOptions(List<String> options) Set the push options supplied by the client.voidUploadPack.setRefFilter(RefFilter refFilter) Set the filter used while advertising the refs to the client.voidUploadPack.setRequestValidator(UploadPack.RequestValidator validator) Set custom validator for client want list.voidUploadPack.setTransferConfig(TransferConfig tc) Set configuration controlling transfer options.voidUploadPack.upload(InputStream input, OutputStream output, OutputStream messages) Execute the upload task on the socket.voidUploadPack.uploadWithExceptionPropagation(InputStream input, OutputStream output, OutputStream messages) Execute the upload task on the socket. -
Uses of Nullable in org.eclipse.jgit.treewalk
Methods in org.eclipse.jgit.treewalk with annotations of type NullableModifier and TypeMethodDescriptionTreeWalk.getCheckoutEolStreamType(int tree) Get the EOL stream type of the current entry for checking out using the config andTreeWalk.getAttributes().TreeWalk.getEolStreamType(TreeWalk.OperationType opType) Get the EOL stream type of the current entry using the config andTreeWalk.getAttributes().Method parameters in org.eclipse.jgit.treewalk with annotations of type NullableModifier and TypeMethodDescriptionstatic TreeWalkTreeWalk.forPath(Repository repo, ObjectReader reader, String path, AnyObjectId... trees) Open a tree walk and filter to exactly one path.Constructor parameters in org.eclipse.jgit.treewalk with annotations of type NullableModifierConstructorDescriptionNameConflictTreeWalk(Repository repo, ObjectReader or) Create a new tree walker for a given repository.TreeWalk(Repository repo, ObjectReader or) Create a new tree walker for a given repository. -
Uses of Nullable in org.eclipse.jgit.treewalk.filter
Method parameters in org.eclipse.jgit.treewalk.filter with annotations of type NullableModifier and TypeMethodDescriptionbooleanTreeFilter.shouldTreeWalk(RevCommit c, RevWalk rw, TreeFilter.MutableBoolean cpfUsed) Return true if the tree entries within this commit requireTreeFilter.include(TreeWalk)to correctly determine whether they are interesting to report. -
Uses of Nullable in org.eclipse.jgit.util
Methods in org.eclipse.jgit.util with annotations of type NullableModifier and TypeMethodDescriptionLfsFactory.getInstallCommand()Retrieve anLfsFactory.LfsInstallCommandwhich can be used to enable LFS support (if available) either per repository or for the user.LfsFactory.getPrePushHook(Repository repo, PrintStream outputStream) Retrieve a pre-push hook to be applied using the default error stream.LfsFactory.getPrePushHook(Repository repo, PrintStream outputStream, PrintStream errorStream) Retrieve a pre-push hook to be applied.static StringRawParseUtils.parseEncodingName(byte[] b) Parse the "encoding " header as a string.protected static StringExecute a command and return a single line of output as a Stringprotected static StringExecute a command and return a single line of output as a Stringstatic ObjectInstanceMonitoring.registerMBean(Object mbean, String metricName) Register a MBean with the platform MBean serverMethod parameters in org.eclipse.jgit.util with annotations of type NullableModifier and TypeMethodDescriptionstatic StringStringUtils.commonPrefix(String... strings) Compares Strings and returns the initial sequence of characters that is common to all of them.static StringSshSupport.runSshCommand(URIish sshUri, CredentialsProvider provider, FS fs, String command, int timeout) Utility to execute a remote SSH command and read the first line of output.RefList.toRefList(BinaryOperator<T> mergeFunction)
Config.getEnum(String, String, String, Enum)or {Config.getEnum(Enum[], String, String, String)} instead.