A B C D E F G H I L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractCommand - Class in com.mooltiverse.oss.nyx.command
-
The common superclass for Nyx commands.
- AbstractCommand(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.AbstractCommand
-
Standard constructor.
- Action - Class in com.mooltiverse.oss.nyx.data
-
This object is a Git action value holder independent from the underlying Git implementation.
- Action(Identity, TimeStamp) - Constructor for class com.mooltiverse.oss.nyx.data.Action
-
Constructor.
- add(Collection<String>) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Adds the given paths to the staging area.
- API_BASE_URL - Static variable in class com.mooltiverse.oss.nyx.services.github.GitHub
-
The API base URL, as per GitHub API
- API_BASE_URL - Static variable in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
The API base URL, as per GitLab API
- apply(Project) - Method in class com.mooltiverse.oss.nyx.gradle.NyxPlugin
-
Creates and registers all the plugin resources for the given project.
- arrange() - Method in class com.mooltiverse.oss.nyx.gradle.ArrangeTask
-
The actual business method for this task.
- arrange() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the
Arrange
command and returns the updated state. - Arrange - Class in com.mooltiverse.oss.nyx.command
-
The Arrange command takes care of fixing the local Git repository, if needed.
- Arrange(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.Arrange
-
Standard constructor.
- ARRANGE - com.mooltiverse.oss.nyx.command.Commands
-
The Arrange command.
- ArrangeTask - Class in com.mooltiverse.oss.nyx.gradle
-
The task running the Arrange command by invoking the
Nyx.arrange()
method on the backing Nyx instance. - ArrangeTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.ArrangeTask
-
Default constructor
- authenticateWithToken(String) - Method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Authenticates by using the given token (Personal Access Token, OAuth)
- authenticateWithToken(String) - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Authenticates by using the given token (Personal Access Token, OAuth)
- authenticateWithToken(String) - Method in interface com.mooltiverse.oss.nyx.services.GitService
-
Authenticates by using the given token (Personal Access Token, OAuth)
B
- Block - Interface in com.mooltiverse.oss.nyx.data
-
This interface models the behavior of a block of properties.
- BUILD_DELIMITER - Static variable in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
The character that marks the separation between the core or the pre-release part and the build part.
- bump(CoreIdentifiers) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the number identified by the given value bumped.
- bump(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the number identified by the given value bumped.
- bump(String) - Method in class com.mooltiverse.oss.nyx.version.Version
-
Returns a new instance with the number identified by the given value bumped.
- BUMP - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The default version identifier to bump.
- bumpMajor() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the major number of this current instance incremented by one and the minor and patch numbers reset to zero.
- bumpMinor() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the major number of this current instance, the minor number incremented by one and the patch number reset to zero.
- bumpPatch() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the major and minor numbers of this current instance and the patch number incremented by one.
- bumpPrerelease(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the number identified by the given value bumped in the prerelease part.
C
- clean() - Method in class com.mooltiverse.oss.nyx.gradle.CleanTask
-
The actual business method for this task.
- clean() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the
Clean
command to restore the state of the workspace to ints initial state. - Clean - Class in com.mooltiverse.oss.nyx.command
-
The Clean command takes care of cleaning the release process and reverting the repository state to its initial state.
- Clean(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.Clean
-
Standard constructor.
- CLEAN - com.mooltiverse.oss.nyx.command.Commands
-
The Clean command.
- CleanTask - Class in com.mooltiverse.oss.nyx.gradle
-
The task running the Clean command by invoking the
Nyx.clean()
method on the backing Nyx instance. - CleanTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.CleanTask
-
Default constructor
- com.mooltiverse.oss.nyx - package com.mooltiverse.oss.nyx
- com.mooltiverse.oss.nyx.command - package com.mooltiverse.oss.nyx.command
- com.mooltiverse.oss.nyx.configuration - package com.mooltiverse.oss.nyx.configuration
- com.mooltiverse.oss.nyx.data - package com.mooltiverse.oss.nyx.data
- com.mooltiverse.oss.nyx.git - package com.mooltiverse.oss.nyx.git
- com.mooltiverse.oss.nyx.gradle - package com.mooltiverse.oss.nyx.gradle
- com.mooltiverse.oss.nyx.log - package com.mooltiverse.oss.nyx.log
- com.mooltiverse.oss.nyx.services - package com.mooltiverse.oss.nyx.services
- com.mooltiverse.oss.nyx.services.github - package com.mooltiverse.oss.nyx.services.github
- com.mooltiverse.oss.nyx.services.gitlab - package com.mooltiverse.oss.nyx.services.gitlab
- com.mooltiverse.oss.nyx.state - package com.mooltiverse.oss.nyx.state
- com.mooltiverse.oss.nyx.version - package com.mooltiverse.oss.nyx.version
- Command - Interface in com.mooltiverse.oss.nyx.command
-
The Command interface must be implemented by all Nyx commands.
- COMMAND - Static variable in class com.mooltiverse.oss.nyx.log.Markers
-
The
COMMAND
marker, used when logging command events. - Commands - Enum in com.mooltiverse.oss.nyx.command
-
The enumeration of available commands.
- commit(String) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Commits changes to the repository.
- commit(String, Identity, Identity) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Commits changes to the repository.
- commit(Collection<String>, String) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Adds the given files to the staging area and commits changes to the repository.
- commit(Collection<String>, String, Identity, Identity) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Adds the given files to the staging area and commits changes to the repository.
- Commit - Class in com.mooltiverse.oss.nyx.data
-
This object is a Git commit value holder independent from the underlying Git implementation.
- Commit(String, int, List<String>, Action, Action, Message, Set<Tag>) - Constructor for class com.mooltiverse.oss.nyx.data.Commit
-
Constructor.
- CommitVisitor - Interface in com.mooltiverse.oss.nyx.git
-
This functional interface is used when browsing Git commits and lets consumers receive summary implementation-independent informations about a single commit.
- compareTo(SemanticVersion) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Compares this version with the specified version for order.
- conditionallyDefine(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.ReleaseTask
-
Registers the task into the given project if no task with the same name has already been registered.
- configuration() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Returns the configuration.
- Configuration - Class in com.mooltiverse.oss.nyx.configuration
-
The Nyx configuration.
- Configuration() - Constructor for class com.mooltiverse.oss.nyx.configuration.Configuration
-
Default constructor.
- CONFIGURATION - Static variable in class com.mooltiverse.oss.nyx.log.Markers
-
The
CONFIGURATION
marker, used when logging configuration events. - ConfigurationLayer - Interface in com.mooltiverse.oss.nyx.configuration
-
This interface models the behavior of a root block layer within the multi-layered configuration.
- configure(AbstractTask) - Static method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Configures the task by defining properties common to all core tasks.
- configure(ArrangeTask) - Static method in class com.mooltiverse.oss.nyx.gradle.ArrangeTask
-
Configures the task (group, description, dependencies, properties).
- configure(CleanTask) - Static method in class com.mooltiverse.oss.nyx.gradle.CleanTask
-
Configures the task (group, description, dependencies, properties).
- configure(InferTask) - Static method in class com.mooltiverse.oss.nyx.gradle.InferTask
-
Configures the task (group, description, dependencies, properties).
- configure(MakeTask) - Static method in class com.mooltiverse.oss.nyx.gradle.MakeTask
-
Configures the task (group, description, dependencies, properties).
- configure(MarkTask) - Static method in class com.mooltiverse.oss.nyx.gradle.MarkTask
-
Configures the task (group, description, dependencies, properties).
- configure(PublishTask) - Static method in class com.mooltiverse.oss.nyx.gradle.PublishTask
-
Configures the task (group, description, dependencies, properties).
- configure(ReleaseTask) - Static method in class com.mooltiverse.oss.nyx.gradle.ReleaseTask
-
Configures the task.
- Constants - Interface in com.mooltiverse.oss.nyx.gradle
-
An interface with constant declarations.
- CoreIdentifiers - Enum in com.mooltiverse.oss.nyx.version
-
The identifiers used for core version numbers.
- CoreTask - Class in com.mooltiverse.oss.nyx.gradle
-
The abstract superclass for all Nyx core tasks.
- CoreTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Default constructor.
- create(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Creates the extension into the given project.
- createExtensions(Project) - Method in class com.mooltiverse.oss.nyx.gradle.NyxPlugin
-
Creates the plugin extensions for the project.
- CUSTOM_ENDPOINT - com.mooltiverse.oss.nyx.services.GitServiceFeature
-
When this feature is supported then the implementation class supports custom API endpoints (i.e.
D
- DataAccessException - Exception in com.mooltiverse.oss.nyx.data
-
This exception models an issue pertaining data access.
- DataAccessException() - Constructor for exception com.mooltiverse.oss.nyx.data.DataAccessException
-
Constructs a new exception with
null
as its detail message. - DataAccessException(String) - Constructor for exception com.mooltiverse.oss.nyx.data.DataAccessException
-
Constructs a new exception with the specified detail message.
- DataAccessException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.data.DataAccessException
-
Constructs a new exception with the specified detail message and cause.
- DataAccessException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.data.DataAccessException
-
Constructs a new exception with the specified cause.
- DEBUG - com.mooltiverse.oss.nyx.data.Verbosity
-
The debug log level.
- DEFAULT - Static variable in class com.mooltiverse.oss.nyx.log.Markers
-
The
DEFAULT
marker, used when logging default configuration. - DEFAULT_INITIAL_VERSION - Static variable in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
The default initial version that can be used when non version is yet available.
- defaultInitial(Scheme) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns a Version instance representing the default initial value to use for the given scheme.
- Defaults - Interface in com.mooltiverse.oss.nyx.configuration
-
A utility interface that collects default configuration values.
- define(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.ArrangeTask
-
Registers the task into the given project.
- define(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.CleanTask
-
Registers the task into the given project.
- define(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.InferTask
-
Registers the task into the given project.
- define(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.MakeTask
-
Registers the task into the given project.
- define(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.MarkTask
-
Registers the task into the given project.
- define(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.PublishTask
-
Registers the task into the given project.
- defineTasks(Project) - Method in class com.mooltiverse.oss.nyx.gradle.NyxPlugin
-
Sets up the tasks and dependencies to the project.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.ArrangeTask
-
The description of the task.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.CleanTask
-
The description of the task.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.InferTask
-
The description of the task.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.MakeTask
-
The description of the task.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.MarkTask
-
The description of the task.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.PublishTask
-
The description of the task.
- DESCRIPTION - Static variable in class com.mooltiverse.oss.nyx.gradle.ReleaseTask
-
The description of the task.
- DIRECTORY - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The default working directory.
- DRY_RUN - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The flag that prevents to alter any repository state and instead just log the actions that would be taken.
E
- equals(Object) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.mooltiverse.oss.nyx.version.Version
-
Returns
true
if this version is equal to the given object,false
otherwise - ERROR - com.mooltiverse.oss.nyx.data.Verbosity
-
The error log level.
F
- FATAL - com.mooltiverse.oss.nyx.data.Verbosity
-
The fatal log level.
- from(Scheme) - Static method in enum com.mooltiverse.oss.nyx.data.Scheme
-
Returns the proper scheme mapped from the given version scheme.
- from(String) - Static method in enum com.mooltiverse.oss.nyx.data.Scheme
-
Returns the proper version scheme mapped from the given value.
- from(String) - Static method in enum com.mooltiverse.oss.nyx.data.Verbosity
-
Returns the proper verbosity level mapped from the given value.
- from(Level) - Static method in enum com.mooltiverse.oss.nyx.data.Verbosity
-
Returns the proper verbosity level mapped from the given SLF4J level.
G
- geFullName() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubUser
-
Returns the full name of this user.
- geFullName() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabUser
-
Returns the full name of this user.
- geFullName() - Method in interface com.mooltiverse.oss.nyx.services.GitUser
-
Returns the full name of this user.
- getAttributes() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubUser
-
Returns a read-only map with all the raw properties for the user.
- getAttributes() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabUser
-
Returns a read-only map with all the raw properties for the user.
- getAttributes() - Method in interface com.mooltiverse.oss.nyx.services.GitUser
-
Returns a read-only map with all the raw properties for the user.
- getAuthenticatedUser() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubSession
-
Returns the authenticated user associated with this session.
- getAuthenticatedUser() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabSession
-
Returns the authenticated user associated with this session.
- getAuthenticatedUser() - Method in interface com.mooltiverse.oss.nyx.services.GitSession
-
Returns the authenticated user associated with this session.
- getAuthenticatedUser(GitHubSession) - Static method in class com.mooltiverse.oss.nyx.services.github.GitHubUser
-
Retrieves the authenticated user for the given session.
- getAuthenticatedUser(GitLabSession) - Static method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabUser
-
Retrieves the authenticated user for the given session.
- getAuthorAction() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the author data.
- getBaseURI() - Method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Returns the API base URI for the service instance.
- getBaseURI() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Returns the API base URI for the service instance.
- getBaseURI() - Method in interface com.mooltiverse.oss.nyx.services.GitService
-
Returns the API base URI for the service instance.
- getBuild() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns the build part of the version, if any, or
null
otherwise. - getBuildAttributeValue(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
If an attribute with the given name is present in the build part, return the identifier after that, otherwise return
null
. - getBuildIdentifiers() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns an array of the single identifiers of the build part of the version, if any, or
null
otherwise. - getBump() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the version identifier to bump as it's defined by this configuration.
- getBump() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the version identifier to bump as it's defined by this configuration.
- getBump() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the name of the version identifier to bump.
- getBump() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the version identifier bumped on the previous release to produce the new release, if any.
- getBump() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the version identifier bumped on the previous release to produce the new release, if any.
- getCommitAction() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the committer data.
- getCommitTags(String) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Returns a set of abjects representing all the tags for the given commit.
- getConfiguration() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the configuration object.
- getConfiguration() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the configuration object.
- getCore() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns the core part (
major.minor.patch
) of the version as a string. - getCoreIdentifiers() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns an array of the single identifiers of the core part of the version
- getDate() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the commit date.
- getDirectory() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the directory to use as the working directory as it's defined by this configuration.
- getDirectory() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the directory to use as the working directory as it's defined by this configuration.
- getDirectory() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the directory to use as the base repository location.
- getDirectory() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the directory used as the working directory as it's defined by the configuration.
- getDirectory() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the directory used as the working directory as it's defined by the configuration.
- getDryRun() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the value of the dry run flag as it's defined by this configuration.
- getDryRun() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the value of the dry run flag as it's defined by this configuration.
- getDryRun() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the flag that, when
true
, prevents Nyx from applying any change to the repository or any other resource. - getEmail() - Method in class com.mooltiverse.oss.nyx.data.Identity
-
Returns the email.
- getFinalCommit() - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Returns the SHA-1 identifier of the last commit within the scope.
- getFooters() - Method in class com.mooltiverse.oss.nyx.data.Message
-
Returns the immutable list of footers, where keys are names and values are values.
- getFullMessage() - Method in class com.mooltiverse.oss.nyx.data.Message
-
Returns the full message.
- getID() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubUser
-
Returns the ID of this user.
- getID() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabUser
-
Returns the ID of this user.
- getID() - Method in interface com.mooltiverse.oss.nyx.services.GitUser
-
Returns the ID of this user.
- getIdentity() - Method in class com.mooltiverse.oss.nyx.data.Action
-
Returns the identity.
- getInitialCommit() - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Returns the SHA-1 identifier of the first commit within the scope.
- getInitialVersion() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the initial version defined by this configuration to use when no past version is available in the commit history.
- getInitialVersion() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the initial version defined by this configuration to use when no past version is available in the commit history.
- getInitialVersion() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the initial version to use when no past version can be inferred from the commit history.
- getInternals() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the live map of internal attributes.
- getInternals() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the live map of internal attributes.
- getLatestCommit() - Method in class com.mooltiverse.oss.nyx.command.AbstractCommand
-
Returns the SHA-1 identifier of the last commit in the current branch.
- getLatestCommit() - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Returns the SHA-1 identifier of the last commit in the current branch.
- getLevel() - Method in enum com.mooltiverse.oss.nyx.data.Verbosity
-
Returns the SLF4J level corresponding to this verbosity level
- getMajor() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns the major version number
- getMessage() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the commit message.
- getMinor() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns the minor version number
- getName() - Method in class com.mooltiverse.oss.nyx.data.Identity
-
Returns the name.
- getName() - Method in class com.mooltiverse.oss.nyx.data.Tag
-
Returns the name.
- getName() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension.Service
-
Returns the name read-only mandatory property.
- getName() - Method in enum com.mooltiverse.oss.nyx.version.CoreIdentifiers
-
Returns the name of the identifier.
- getObjectfactory() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns an object factory instance.
- getParents() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the immutable list of parent commit SHA-1 identifiers.
- getPatch() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns the patch version number
- getPrefix(String) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Takes the given string and tries to parse it as a semantic version with an optional prefix (which may be any string before the core
major.minor.patch
numbers). - getPrerelease() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns the prerelease part of the version, if any, or
null
otherwise. - getPrereleaseAttributeValue(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
If an attribute with the given name is present in the prerelease part, return the identifier after that, otherwise return
null
. - getPrereleaseIdentifiers() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns an array of the single identifiers of the prerelease part of the version, if any, or
null
otherwise. - getPreviousVersion() - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Returns the version identifier of the most recent past release.
- getPreviousVersionCommit() - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Returns the SHA-1 identifier of the most recent past release commit.
- getProjectLayout() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns a project layout instance.
- getReleaseLenient() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the flag that enables tolerance in reading release names with arbitrary prefixes or extra non critical characters as it's defined by this configuration.
- getReleaseLenient() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the flag that enables tolerance in reading release names with arbitrary prefixes or extra non critical characters as it's defined by this configuration.
- getReleaseLenient() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the flag that, when
true
, lets Nyx interpret release names with whatever prefix. - getReleasePrefix() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the prefix to use in release name generation as it's defined by this configuration.
- getReleasePrefix() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the prefix to use in release name generation as it's defined by this configuration.
- getReleasePrefix() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the prefix used to generate release names.
- getReleaseScope() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the object modelling the attributes defining the scope of the release.
- getReleaseScope() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the object modelling the attributes defining the scope of the release.
- getRootCommit() - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Returns the SHA-1 identifier of the first commit in the repository (the only commit with no parents).
- getScheme() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the versioning scheme to use as it's defined by this configuration.
- getScheme() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the versioning scheme to use as it's defined by this configuration.
- getScheme() - Method in enum com.mooltiverse.oss.nyx.data.Scheme
-
Returns the version scheme
- getScheme() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the versioning scheme to use.
- getScheme() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the versioning scheme used as it's defined by the configuration.
- getScheme() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the versioning scheme used as it's defined by the configuration.
- getScheme() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns
Scheme.SEMVER
. - getScheme() - Method in class com.mooltiverse.oss.nyx.version.Version
-
Returns the scheme that identifies the implementation
- getService() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubSession
-
Returns the service instance backing this session.
- getService() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabSession
-
Returns the service instance backing this session.
- getService() - Method in interface com.mooltiverse.oss.nyx.services.GitSession
-
Returns the service instance backing this session.
- getServiceClass() - Method in enum com.mooltiverse.oss.nyx.services.GitProvider
-
Returns the class implementing the service.
- getServices() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the nested 'service' blocks.
- getSHA() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the SHA-1 identifier for the commit.
- getShortMessage() - Method in class com.mooltiverse.oss.nyx.data.Message
-
Returns the short message.
- getSignificant() - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Returns the flag telling if the release scope contains significant commits.
- getTags() - Method in class com.mooltiverse.oss.nyx.data.Commit
-
Returns the immutable list of tags pointing to this commit.
- getTarget() - Method in class com.mooltiverse.oss.nyx.data.Tag
-
Returns the ID (SHA-1) of the tagged object.
- getTimestamp() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the current timestamp.
- getTimestamp() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the current timestamp.
- getTimeStamp() - Method in class com.mooltiverse.oss.nyx.data.Action
-
Returns the time stamp.
- getTimeStamp() - Method in class com.mooltiverse.oss.nyx.data.TimeStamp
-
Returns the time stamp.
- getTimeZone() - Method in class com.mooltiverse.oss.nyx.data.TimeStamp
-
Returns the time zone.
- getUserName() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubUser
-
Returns the user name of this user.
- getUserName() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabUser
-
Returns the user name of this user.
- getUserName() - Method in interface com.mooltiverse.oss.nyx.services.GitUser
-
Returns the user name of this user.
- getValue() - Method in enum com.mooltiverse.oss.nyx.data.Scheme
-
Returns the string representation of this scheme.
- getValue() - Method in enum com.mooltiverse.oss.nyx.data.Verbosity
-
Returns the string representation of this verbosity level.
- getVerbosity() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the logging verbosity level as it's defined by this configuration.
- getVerbosity() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the logging verbosity level as it's defined by this configuration.
- getVerbosity() - Method in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
Returns the logging verbosity.
- getVersion() - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Returns the version defined by this configuration.
- getVersion() - Method in interface com.mooltiverse.oss.nyx.configuration.Root
-
Returns the version defined by this configuration.
- getVersion() - Method in interface com.mooltiverse.oss.nyx.state.Root
-
Returns the version inferred by Nyx, if any.
- getVersion() - Method in class com.mooltiverse.oss.nyx.state.State
-
Returns the version inferred by Nyx, if any.
- getVersionInternal() - Method in class com.mooltiverse.oss.nyx.state.State
-
Gets the version attribute.
- Git - Class in com.mooltiverse.oss.nyx.git
-
This is the factory class for
Repository
instances. - GitAuthenticationException - Exception in com.mooltiverse.oss.nyx.services
-
An exception meaning that authentication failed or expired.
- GitAuthenticationException(String) - Constructor for exception com.mooltiverse.oss.nyx.services.GitAuthenticationException
-
Constructs a new exception with the specified detail message.
- GitAuthenticationException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitAuthenticationException
-
Constructs a new exception with the specified detail message and cause.
- GitAuthenticationException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitAuthenticationException
-
Constructs a new exception with the specified cause
- GitAuthorizationException - Exception in com.mooltiverse.oss.nyx.services
-
An exception meaning that authorization failed or expired.
- GitAuthorizationException(String) - Constructor for exception com.mooltiverse.oss.nyx.services.GitAuthorizationException
-
Constructs a new exception with the specified detail message.
- GitAuthorizationException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitAuthorizationException
-
Constructs a new exception with the specified detail message and cause.
- GitAuthorizationException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitAuthorizationException
-
Constructs a new exception with the specified cause
- GitException - Exception in com.mooltiverse.oss.nyx.git
-
A generic exception raised when some Git related issue is encountered.
- GitException() - Constructor for exception com.mooltiverse.oss.nyx.git.GitException
-
Constructs a new exception with
null
as its detail message. - GitException(String) - Constructor for exception com.mooltiverse.oss.nyx.git.GitException
-
Constructs a new exception with the specified detail message.
- GitException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.git.GitException
-
Constructs a new exception with the specified detail message and cause.
- GitException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.git.GitException
-
Constructs a new exception with the specified cause.
- GitHub - Class in com.mooltiverse.oss.nyx.services.github
-
The entry point to the GitHub service.
- GITHUB - com.mooltiverse.oss.nyx.services.GitProvider
-
The GitHub service provider.
- GitHubSession - Class in com.mooltiverse.oss.nyx.services.github
-
An (authenticated) session for a remote GitHub service.
- GitHubUser - Class in com.mooltiverse.oss.nyx.services.github
-
A user for a remote GitHub service.
- GitLab - Class in com.mooltiverse.oss.nyx.services.gitlab
-
The entry point to the GitLab service.
- GITLAB - com.mooltiverse.oss.nyx.services.GitProvider
-
The GitLab service provider.
- GitLabSession - Class in com.mooltiverse.oss.nyx.services.gitlab
-
An (authenticated) session for a remote GitLab service.
- GitLabUser - Class in com.mooltiverse.oss.nyx.services.gitlab
-
A user for a remote GitLab service.
- GitProvider - Enum in com.mooltiverse.oss.nyx.services
-
These are the constants representing the available services and their implementation classes.
- GitSecurityException - Exception in com.mooltiverse.oss.nyx.services
-
An exception meaning that security constraints failed their checks.
- GitSecurityException(String) - Constructor for exception com.mooltiverse.oss.nyx.services.GitSecurityException
-
Constructs a new exception with the specified detail message.
- GitSecurityException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitSecurityException
-
Constructs a new exception with the specified detail message and cause.
- GitSecurityException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitSecurityException
-
Constructs a new exception with the specified cause
- GitService - Interface in com.mooltiverse.oss.nyx.services
-
An abstraction over Git services.
- GitServiceException - Exception in com.mooltiverse.oss.nyx.services
-
A generic Git exception class that indicates an issue with a remote service.
- GitServiceException(String) - Constructor for exception com.mooltiverse.oss.nyx.services.GitServiceException
-
Constructs a new exception with the specified detail message.
- GitServiceException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitServiceException
-
Constructs a new exception with the specified detail message and cause.
- GitServiceException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitServiceException
-
Constructs a new exception with the specified cause
- GitServiceFactory - Class in com.mooltiverse.oss.nyx.services
-
The generic entry point to retrieve service implementations.
- GitServiceFeature - Enum in com.mooltiverse.oss.nyx.services
-
These are the constants representing the features that may or may not be supported by providers.
- GitSession - Interface in com.mooltiverse.oss.nyx.services
-
An (authenticated) session for a remote Git service.
- GitTransportException - Exception in com.mooltiverse.oss.nyx.services
-
An exception meaning that something in the transport or connection went wrong.
- GitTransportException(String) - Constructor for exception com.mooltiverse.oss.nyx.services.GitTransportException
-
Constructs a new exception with the specified detail message.
- GitTransportException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitTransportException
-
Constructs a new exception with the specified detail message and cause.
- GitTransportException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.services.GitTransportException
-
Constructs a new exception with the specified cause
- GitUser - Interface in com.mooltiverse.oss.nyx.services
-
A user for a remote Git service.
- GRADLE_VERSION_PROPERTY_NAME - Static variable in interface com.mooltiverse.oss.nyx.gradle.Constants
-
The name of the Gradle project property that brings the project version.
H
- hasBuildAttribute(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns
true
if an attribute with the given name is present in the build part,false
otherwise. - hashCode() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a hash code value for the object.
- hashCode() - Method in class com.mooltiverse.oss.nyx.version.Version
-
Returns the hash code for this object
- hasPrereleaseAttribute(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns
true
if an attribute with the given name is present in the prerelease part,false
otherwise. - hasSharedProperty(String) - Method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Returns
true
if there is a project with the given name stored for the project.
I
- ID - Static variable in class com.mooltiverse.oss.nyx.gradle.NyxPlugin
-
The plugin ID.
- Identity - Class in com.mooltiverse.oss.nyx.data
-
This object is a Git identity value holder independent from the underlying Git implementation.
- Identity(String, String) - Constructor for class com.mooltiverse.oss.nyx.data.Identity
-
Constructor.
- IllegalPropertyException - Exception in com.mooltiverse.oss.nyx.data
-
This exception models an issue pertaining a data property.
- IllegalPropertyException() - Constructor for exception com.mooltiverse.oss.nyx.data.IllegalPropertyException
-
Constructs a new exception with
null
as its detail message. - IllegalPropertyException(String) - Constructor for exception com.mooltiverse.oss.nyx.data.IllegalPropertyException
-
Constructs a new exception with the specified detail message.
- IllegalPropertyException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.data.IllegalPropertyException
-
Constructs a new exception with the specified detail message and cause.
- IllegalPropertyException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.data.IllegalPropertyException
-
Constructs a new exception with the specified cause.
- infer() - Method in class com.mooltiverse.oss.nyx.gradle.InferTask
-
The actual business method for this task.
- infer() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the
Infer
command and returns the updated state. - Infer - Class in com.mooltiverse.oss.nyx.command
-
The Infer command takes care of inferring and computing informations in order to make a new release.
- Infer(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.Infer
-
Standard constructor.
- INFER - com.mooltiverse.oss.nyx.command.Commands
-
The Infer command.
- InferTask - Class in com.mooltiverse.oss.nyx.gradle
-
The task running the Infer command by invoking the
Nyx.infer()
method on the backing Nyx instance. - InferTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.InferTask
-
Default constructor
- INFO - com.mooltiverse.oss.nyx.data.Verbosity
-
The info log level.
- INITIAL_VERSION - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The initial version to use.
- instance() - Static method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Returns an instance using the default API URI (
GitHub.API_BASE_URL
). - instance() - Static method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Returns an instance using the default API URI (
GitLab.API_BASE_URL
). - instance(GitProvider) - Static method in class com.mooltiverse.oss.nyx.services.GitServiceFactory
-
Returns an instance for the given provider using the default API URI.
- instance(GitProvider, String) - Static method in class com.mooltiverse.oss.nyx.services.GitServiceFactory
-
Returns an instance for the given provider using the given API URI.
- instance(GitProvider, URI) - Static method in class com.mooltiverse.oss.nyx.services.GitServiceFactory
-
Returns an instance for the given provider using the given API URI.
- instance(String) - Static method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Returns an instance using the given API URI.
- instance(String) - Static method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Returns an instance using the given API URI.
- instance(URI) - Static method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Returns an instance using the given API URI.
- instance(URI) - Static method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Returns an instance using the given API URI.
- isAnnotated() - Method in class com.mooltiverse.oss.nyx.data.Tag
-
Returns
true
if this is an annotated tag,false
if it's a lightweight tag. - isClean() - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Returns
true
if the repository is clean, which is when no differences exist between the working tree, the index, and the currentHEAD
. - isLegal(Scheme, String) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns
true
if the given string is a legal version which, for example, can be parsed usingvalueOf(Scheme, String)
without exceptions using the implementation selected by the given scheme. - isLegal(Scheme, String, boolean) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns
true
if the given string is a legal version which, for example, can be parsed usingvalueOf(Scheme, String, boolean)
without exceptions using the implementation selected by the given scheme. - isLegal(Scheme, String, String) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns
true
if the given string is a legal version which, for example, can be parsed usingvalueOf(Scheme, String, boolean)
without exceptions using the implementation selected by the given scheme. - isLegal(String) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns
true
if the given string is a legal semantic version which, for example, can be parsed usingSemanticVersion.valueOf(String)
without exceptions. - isLegal(String, boolean) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns
true
if the given string is a legal semantic version which, for example, can be parsed usingSemanticVersion.valueOf(String, boolean)
without exceptions. - isOptional() - Method in enum com.mooltiverse.oss.nyx.services.GitServiceFeature
-
Returns
true
if the feature is optional. - isRepositoryClean() - Method in class com.mooltiverse.oss.nyx.command.AbstractCommand
-
Returns
true
if the repository is in a clean state (no uncommitted changes). - isUpToDate() - Method in class com.mooltiverse.oss.nyx.command.Arrange
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate() - Method in class com.mooltiverse.oss.nyx.command.Clean
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate() - Method in interface com.mooltiverse.oss.nyx.command.Command
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate() - Method in class com.mooltiverse.oss.nyx.command.Infer
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate() - Method in class com.mooltiverse.oss.nyx.command.Make
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate() - Method in class com.mooltiverse.oss.nyx.command.Mark
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate() - Method in class com.mooltiverse.oss.nyx.command.Publish
-
Returns
true
if this command is up to date, which means that the internal state (Command.state()
) would not change by running (Command.run()
) the command again. - isUpToDate(Commands) - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs
true
if the given command has already run and is up to date,false
otherwise.
L
- Layer - Interface in com.mooltiverse.oss.nyx.data
-
This interface models the behavior of a layer within multi-layered data structures.
M
- MAIN - Static variable in class com.mooltiverse.oss.nyx.log.Markers
-
The
MAIN
marker, used when logging events from the main classes. - MAJOR - com.mooltiverse.oss.nyx.version.CoreIdentifiers
-
The major number.
- make() - Method in class com.mooltiverse.oss.nyx.gradle.MakeTask
-
The actual business method for this task.
- make() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the
Make
command and returns the updated state. - Make - Class in com.mooltiverse.oss.nyx.command
-
The Make command takes care of building the release artifacts.
- Make(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.Make
-
Standard constructor.
- MAKE - com.mooltiverse.oss.nyx.command.Commands
-
The Make command.
- MakeTask - Class in com.mooltiverse.oss.nyx.gradle
-
The task running the Make command by invoking the
Nyx.make()
method on the backing Nyx instance. - MakeTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.MakeTask
-
Default constructor
- mark() - Method in class com.mooltiverse.oss.nyx.gradle.MarkTask
-
The actual business method for this task.
- mark() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the
Mark
command and returns the updated state. - Mark - Class in com.mooltiverse.oss.nyx.command
-
The Mark command takes care of tagging and committing into the Git repository.
- Mark(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.Mark
-
Standard constructor.
- MARK - com.mooltiverse.oss.nyx.command.Commands
-
The Mark command.
- Markers - Class in com.mooltiverse.oss.nyx.log
-
An utility class with the defined set of markers used.
- MarkTask - Class in com.mooltiverse.oss.nyx.gradle
-
The task running the Mark command by invoking the
Nyx.mark()
method on the backing Nyx instance. - MarkTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.MarkTask
-
Default constructor
- Message - Class in com.mooltiverse.oss.nyx.data
-
This object is a Git commit message value holder independent from the underlying Git implementation.
- Message(String, String, Map<String, String>) - Constructor for class com.mooltiverse.oss.nyx.data.Message
-
Constructor.
- MINOR - com.mooltiverse.oss.nyx.version.CoreIdentifiers
-
The minor number.
N
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.ArrangeTask
-
The name of the task.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.CleanTask
-
The name of the task.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.InferTask
-
The name of the task.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.MakeTask
-
The name of the task.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.MarkTask
-
The name of the task.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.NyxExtension
-
The name of the extension object.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.PublishTask
-
The name of the task.
- NAME - Static variable in class com.mooltiverse.oss.nyx.gradle.ReleaseTask
-
The name of the task.
- nyx() - Method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Returns a shared backing Nyx instance to be used by all tasks within the project.
- Nyx - Class in com.mooltiverse.oss.nyx
-
The Nyx entry point and main class.
- Nyx() - Constructor for class com.mooltiverse.oss.nyx.Nyx
-
Default constructor.
- Nyx(File) - Constructor for class com.mooltiverse.oss.nyx.Nyx
-
Creates a new Nyx instance using the given directory as the base directory.
- NYX_INSTANCE_PROPERTY - Static variable in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
The name used to store and retrieve the extra property that holds the shared backing Nyx instance that can be used by all tasks.
- NyxException - Exception in com.mooltiverse.oss.nyx
-
A superclass for all Nyx specific exceptions.
- NyxException() - Constructor for exception com.mooltiverse.oss.nyx.NyxException
-
Constructs a new exception with
null
as its detail message. - NyxException(String) - Constructor for exception com.mooltiverse.oss.nyx.NyxException
-
Constructs a new exception with the specified detail message.
- NyxException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.NyxException
-
Constructs a new exception with the specified detail message and cause.
- NyxException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.NyxException
-
Constructs a new exception with the specified cause.
- NyxExtension - Class in com.mooltiverse.oss.nyx.gradle
-
The plugin configuration object.
- NyxExtension() - Constructor for class com.mooltiverse.oss.nyx.gradle.NyxExtension
- NyxExtension.Service - Class in com.mooltiverse.oss.nyx.gradle
-
The class to model a single service item within the 'services' block within the extension.
- NyxPlugin - Class in com.mooltiverse.oss.nyx.gradle
-
The main plugin class.
- NyxPlugin() - Constructor for class com.mooltiverse.oss.nyx.gradle.NyxPlugin
-
Default constructor.
O
- open(File) - Static method in class com.mooltiverse.oss.nyx.git.Git
-
Returns a repository instance working in the given directory.
- open(String) - Static method in class com.mooltiverse.oss.nyx.git.Git
-
Returns a repository instance working in the given directory.
P
- PATCH - com.mooltiverse.oss.nyx.version.CoreIdentifiers
-
The patch number.
- ping() - Method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Tries to contact the remote server to verify it's reachable and healthy.
- ping() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Tries to contact the remote server to verify it's reachable and healthy.
- ping() - Method in interface com.mooltiverse.oss.nyx.services.GitService
-
Tries to contact the remote server to verify it's reachable and healthy.
- PING - com.mooltiverse.oss.nyx.services.GitServiceFeature
-
When this feature is supported then the implementation class supports the
GitService.ping()
method. - PRERELEASE_DELIMITER - Static variable in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
The character that marks the separation between the core and the pre-release part.
- publish() - Method in class com.mooltiverse.oss.nyx.gradle.PublishTask
-
The actual business method for this task.
- publish() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the
Publish
command and returns the updated state. - Publish - Class in com.mooltiverse.oss.nyx.command
-
The Publish command takes care of publishing a release.
- Publish(State, Repository) - Constructor for class com.mooltiverse.oss.nyx.command.Publish
-
Standard constructor.
- PUBLISH - com.mooltiverse.oss.nyx.command.Commands
-
The Publish command.
- PublishTask - Class in com.mooltiverse.oss.nyx.gradle
-
The task running the Publish command by invoking the
Nyx.publish()
method on the backing Nyx instance. - PublishTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.PublishTask
-
Default constructor
- push() - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Pushes local changes in the current branch to the default remote
origin
. - push(String) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Pushes local changes in the current branch to the given remote.
- push(Collection<String>) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Pushes local changes in the current branch to the given remotes.
R
- RELEASE_LENIENT - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The flag that alows reading releases from the history tolerating arbitrary prefixes and extra non critical characters.
- RELEASE_PREFIX - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The default prefix to add at the beginning of a version identifier to generate the release identifier.
- ReleaseException - Exception in com.mooltiverse.oss.nyx
-
This exception is raised when Nyx encounters an issue during the business operations.
- ReleaseException() - Constructor for exception com.mooltiverse.oss.nyx.ReleaseException
-
Constructs a new exception with
null
as its detail message. - ReleaseException(String) - Constructor for exception com.mooltiverse.oss.nyx.ReleaseException
-
Constructs a new exception with the specified detail message.
- ReleaseException(String, Throwable) - Constructor for exception com.mooltiverse.oss.nyx.ReleaseException
-
Constructs a new exception with the specified detail message and cause.
- ReleaseException(Throwable) - Constructor for exception com.mooltiverse.oss.nyx.ReleaseException
-
Constructs a new exception with the specified cause.
- ReleaseScope - Class in com.mooltiverse.oss.nyx.data
-
This is a value object that models the summary data about the scope of a release.
- ReleaseScope() - Constructor for class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Default constructor.
- ReleaseScope(Version, String, String, String, Boolean) - Constructor for class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Constructor.
- ReleaseTask - Class in com.mooltiverse.oss.nyx.gradle
-
The Release lifecycle task.
- ReleaseTask() - Constructor for class com.mooltiverse.oss.nyx.gradle.ReleaseTask
-
Default constructor
- removeBuildAttribute(String, boolean) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the new attribute removed from the build part, if any was present, otherwise the same version is returned.
- removePrereleaseAttribute(String, boolean) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new instance with the new attribute removed from the prerelease part, if any was present, otherwise the same version is returned.
- repository() - Method in class com.mooltiverse.oss.nyx.command.AbstractCommand
-
Returns the repository object.
- repository() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Returns the repository.
- Repository - Interface in com.mooltiverse.oss.nyx.git
-
This interface models coarse grained, implementation independent methods used by Nyx to access a Git repository.
- retrieveExtension() - Method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Returns the instance of the extension for the task.
- retrieveExtension(Project) - Static method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Returns the instance of the extension for the given project.
- retrieveSharedProperty(String) - Method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Retrieves the shared project property with the given name.
- Root - Interface in com.mooltiverse.oss.nyx.configuration
-
This interface models the configuration root block, with global options.
- Root - Interface in com.mooltiverse.oss.nyx.state
-
This interface models the state root block, with global attributes.
- run() - Method in class com.mooltiverse.oss.nyx.command.Arrange
-
Runs the command and returns the updated reference to the state object.
- run() - Method in class com.mooltiverse.oss.nyx.command.Clean
-
Reverts the workspace to its initial state and returns
null
. - run() - Method in interface com.mooltiverse.oss.nyx.command.Command
-
Runs the command and returns the updated reference to the state object.
- run() - Method in class com.mooltiverse.oss.nyx.command.Infer
-
Infers all the required informations to produce a new release from the Git repository.
- run() - Method in class com.mooltiverse.oss.nyx.command.Make
-
Runs the command and returns the updated reference to the state object.
- run() - Method in class com.mooltiverse.oss.nyx.command.Mark
-
Commits pending changes to the Git repository, applies a release tags and pushes changes to remotes.
- run() - Method in class com.mooltiverse.oss.nyx.command.Publish
-
Runs the command and returns the updated reference to the state object.
- run(Commands) - Method in class com.mooltiverse.oss.nyx.Nyx
-
Runs the given command.
S
- sanitize(String) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Performs all of the sanitizations in the given string by sanitizing, in order, the prefix and leading zeroes in numeric identifiers.
- sanitizeNumbers(String) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Takes the given string and tries to parse it as a semantic version number, even with illegal characters or prefix.
- sanitizePrefix(String) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Takes the given string and tries to parse it as a semantic version with an optional prefix (which may be any string before the core
major.minor.patch
numbers). - Scheme - Enum in com.mooltiverse.oss.nyx.data
- Scheme - Enum in com.mooltiverse.oss.nyx.version
-
The values of this enum are used to select the versioning scheme to use.
- SCHEME - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The versioning scheme to use.
- SEMANTIC_VERSION_PATTERN - Static variable in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
The regexp pattern taken directly from Semantic Versioning 2.0.0 used to parse semantic versions.
- SEMANTIC_VERSION_PATTERN_RELAXED - Static variable in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
A relaxed version of the
SemanticVersion.SEMANTIC_VERSION_PATTERN
that works also when a prefix appears at the beginning of the version string or some zeroes appear in front of numbers. - SemanticVersion - Class in com.mooltiverse.oss.nyx.version
-
The implementation of a Semantic Versioning 2.0.0 compliant version.
- SemanticVersion(int, int, int) - Constructor for class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Builds a new version object with the given values.
- SemanticVersion(int, int, int, Object[], String[]) - Constructor for class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Builds a new version object with the given values.
- SEMVER - com.mooltiverse.oss.nyx.data.Scheme
-
The Semantic Versioning scheme.
- SEMVER - com.mooltiverse.oss.nyx.version.Scheme
-
The Semantic Versioning scheme.
- Service(String) - Constructor for class com.mooltiverse.oss.nyx.gradle.NyxExtension.Service
-
Constructor.
- Services - Interface in com.mooltiverse.oss.nyx.configuration
-
This interface models the configuration block that defines the configured services.
- setBuild(String...) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the build part set to the given values.
- setBuildAttribute(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the new attribute added or replaced in the build part.
- setBuildAttribute(String, String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the new attribute added or replaced in the build part.
- setBump(String) - Method in class com.mooltiverse.oss.nyx.state.State
-
Sets the version identifier bumped on the previous release to produce the new release, if any.
- setCore(int, int, int) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the
major
,minor
andpatch
numbers set to the given values. - setDefaultDirectory(File) - Static method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
This method allows to override the default directory that will be returned by
Configuration.getDirectory()
. - setFinalCommit(String) - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Sets the SHA-1 identifier of the last commit within the scope.
- setInitialCommit(String) - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Sets the SHA-1 identifier of the first commit within the scope.
- setMajor(int) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the
major
number set to the given value. - setMinor(int) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the
minor
number set to the given value. - setPatch(int) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the
patch
number set to the given value. - setPrerelease(Object...) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the prerelease part set to the given values.
- setPrereleaseAttribute(String) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the new attribute added or replaced in the prerelease part.
- setPrereleaseAttribute(String, Integer) - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a new version object with the new attribute added or replaced in the prerelease part.
- setPreviousVersion(Version) - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Sets the version identifier of the most recent past release.
- setPreviousVersionCommit(String) - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Sets the SHA-1 identifier of the most recent past release commit.
- setSignificant(Boolean) - Method in class com.mooltiverse.oss.nyx.data.ReleaseScope
-
Sets the flag telling if the release scope contains significant commits.
- setVersionInternal(Version) - Method in class com.mooltiverse.oss.nyx.state.State
-
Sets the version attribute.
- state() - Method in class com.mooltiverse.oss.nyx.command.AbstractCommand
-
Returns the state object.
- state() - Method in interface com.mooltiverse.oss.nyx.command.Command
-
Returns the state object.
- state() - Method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Returns the state of the shared backing Nyx instance.
- state() - Method in class com.mooltiverse.oss.nyx.Nyx
-
Returns the state.
- State - Class in com.mooltiverse.oss.nyx.state
-
The State class holds a number of attributes resulting from the execution of one or more command and so represents the current status of a release process at a certain point in time.
- State(Configuration) - Constructor for class com.mooltiverse.oss.nyx.state.State
-
Standard constructor.
- STATE - Static variable in class com.mooltiverse.oss.nyx.log.Markers
-
The
STATE
marker, used when logging state events. - storeSharedProperty(String, Object) - Method in class com.mooltiverse.oss.nyx.gradle.CoreTask
-
Stores the given value as a shared project property with the given name.
- supports(GitServiceFeature) - Method in class com.mooltiverse.oss.nyx.services.github.GitHub
-
Safely checks if the underlying implementation supports the given operation.
- supports(GitServiceFeature) - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLab
-
Safely checks if the underlying implementation supports the given operation.
- supports(GitServiceFeature) - Method in interface com.mooltiverse.oss.nyx.services.GitService
-
Safely checks if the underlying implementation supports the given operation.
T
- tag(String) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Tags the latest commit in the current branch with a tag with the given name.
- tag(String, String) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Tags the latest commit in the current branch with a tag with the given name and optional message.
- tag(String, String, Identity) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Tags the latest commit in the current branch with a tag with the given name and optional message using the optional tagger identity.
- tag(String, String, String, Identity) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Tags the object represented by the given SHA-1 with a tag with the given name and optional message using the optional tagger identity.
- Tag - Class in com.mooltiverse.oss.nyx.data
-
This object is a Git tag value holder independent from the underlying Git implementation.
- Tag(String, String, boolean) - Constructor for class com.mooltiverse.oss.nyx.data.Tag
-
Constructor.
- TimeStamp - Class in com.mooltiverse.oss.nyx.data
-
This object is a Git timestamp value holder independent from the underlying Git implementation.
- TimeStamp(Date, TimeZone) - Constructor for class com.mooltiverse.oss.nyx.data.TimeStamp
-
Constructor.
- TOKEN_AUTHENTICATION - com.mooltiverse.oss.nyx.services.GitServiceFeature
-
When this feature is supported then the implementation class supports authentication with tokens (Personal Access Tokens, OAuth).
- toString() - Method in class com.mooltiverse.oss.nyx.data.Action
- toString() - Method in class com.mooltiverse.oss.nyx.data.Commit
- toString() - Method in class com.mooltiverse.oss.nyx.data.Identity
- toString() - Method in class com.mooltiverse.oss.nyx.data.Message
- toString() - Method in class com.mooltiverse.oss.nyx.data.Tag
- toString() - Method in class com.mooltiverse.oss.nyx.data.TimeStamp
- toString() - Method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a string representation of the object.
- toString() - Method in class com.mooltiverse.oss.nyx.version.Version
-
Returns the string representation of this version
- touchTimestamp() - Method in class com.mooltiverse.oss.nyx.state.State
-
Updates the current timestamp and returns the updated value.
- TRACE - com.mooltiverse.oss.nyx.data.Verbosity
-
The trace log level.
U
- update() - Method in class com.mooltiverse.oss.nyx.services.github.GitHubUser
-
Updates the user data and attributes.
- update() - Method in class com.mooltiverse.oss.nyx.services.gitlab.GitLabUser
-
Updates the user data and attributes.
- update() - Method in interface com.mooltiverse.oss.nyx.services.GitUser
-
Updates the user data and attributes.
V
- valueOf(Scheme, String) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns a Version instance representing the specified String value.
- valueOf(Scheme, String, boolean) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns a Version instance representing the specified String value.
- valueOf(Scheme, String, String) - Static method in class com.mooltiverse.oss.nyx.version.VersionFactory
-
Returns a Version instance representing the specified String value.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.command.Commands
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.data.Scheme
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.data.Verbosity
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.services.GitProvider
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.services.GitServiceFeature
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.version.CoreIdentifiers
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mooltiverse.oss.nyx.version.Scheme
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
Returns a SemanticVersion instance representing the specified String value.
- valueOf(String, boolean) - Static method in class com.mooltiverse.oss.nyx.version.SemanticVersion
-
This method is a shorthand for
SemanticVersion.valueOf(String)
andSemanticVersion.sanitize(String)
. - values() - Static method in enum com.mooltiverse.oss.nyx.command.Commands
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mooltiverse.oss.nyx.data.Scheme
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mooltiverse.oss.nyx.data.Verbosity
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mooltiverse.oss.nyx.services.GitProvider
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mooltiverse.oss.nyx.services.GitServiceFeature
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mooltiverse.oss.nyx.version.CoreIdentifiers
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mooltiverse.oss.nyx.version.Scheme
-
Returns an array containing the constants of this enum type, in the order they are declared.
- Verbosity - Enum in com.mooltiverse.oss.nyx.data
-
This class maps log
Level
s and the corresponding configuration options and state attributes, whose string representations may not always match theLevel
values. - VERBOSITY - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The logging level.
- Version - Class in com.mooltiverse.oss.nyx.version
-
The superclass of Version classes.
- Version() - Constructor for class com.mooltiverse.oss.nyx.version.Version
-
Builds the version.
- VERSION - Static variable in interface com.mooltiverse.oss.nyx.configuration.Defaults
-
The release version.
- VersionFactory - Class in com.mooltiverse.oss.nyx.version
-
The utility class used to create version instances.
- visit(Commit) - Method in interface com.mooltiverse.oss.nyx.git.CommitVisitor
-
Visits a single commit and receives all of the commit simplified fields.
W
- walkHistory(String, String, CommitVisitor) - Method in interface com.mooltiverse.oss.nyx.git.Repository
-
Browse the repository commit history using the given
visitor
to inspect each commit. - WARNING - com.mooltiverse.oss.nyx.data.Verbosity
-
The warning log level.
- withPluginConfiguration(ConfigurationLayer) - Method in class com.mooltiverse.oss.nyx.configuration.Configuration
-
Adds, replaces or removes the layer at the
LayerPriority.PLUGIN
level.
All Classes All Packages