net.covers1624.quack.maven

Class MavenNotation

java.lang.Object

net.covers1624.quack.maven.MavenNotation

All Implemented Interfaces:

java.io.Serializable

public class MavenNotation
extends java.lang.Object
implements java.io.Serializable

Simple Immutable class for a Maven artifacts notation.

Created by covers1624 on 19/02/19.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
@Nullable java.lang.String	classifier
java.lang.String	extension
java.lang.String	group
java.lang.String	module
@Nullable java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
MavenNotation(MavenNotation other)
MavenNotation(java.lang.String group, java.lang.String module, @Nullable java.lang.String version, @Nullable java.lang.String classifier, java.lang.String extension)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
static MavenNotation	parse(java.lang.String str) Parses a Maven string to a MavenNotation instance.
java.io.File	toFile(java.io.File dir) Converts this MavenNotation to a file relative to the given base directory.
java.lang.String	toFileName() Converts this MavenNotation to a file name.
java.lang.String	toModulePath() Converts this MavenNotation to the module folder path.
java.lang.String	toPath() Converts this MavenNotation to a path segment, either for a URL or File path.
java.nio.file.Path	toPath(java.nio.file.Path dir) Converts this MavenNotation to a Path relative to the given base directory.
java.lang.String	toString()
java.net.URL	toURL(java.lang.String repo) Converts this MavenNotation to a URL from the given URL.
MavenNotation	withClassifier(@Nullable java.lang.String classifier)
MavenNotation	withExtension(java.lang.String extension)
MavenNotation	withGroup(java.lang.String group)
MavenNotation	withModule(java.lang.String module)
MavenNotation	withVersion(@Nullable java.lang.String version)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

group

public final java.lang.String group

module

public final java.lang.String module

version

@Nullable
public final @Nullable java.lang.String version

classifier

@Nullable
public final @Nullable java.lang.String classifier

extension

public final java.lang.String extension

Constructor Detail

MavenNotation

public MavenNotation(java.lang.String group,
                     java.lang.String module,
                     @Nullable
                     @Nullable java.lang.String version,
                     @Nullable
                     @Nullable java.lang.String classifier,
                     java.lang.String extension)

MavenNotation

public MavenNotation(MavenNotation other)

Method Detail

parse

public static MavenNotation parse(java.lang.String str)

Parses a Maven string to a MavenNotation instance. Format: group:module[:version][:classifier][@extension]

Parameters:

str - The string.

Returns:

The new MavenNotation.

withGroup

public MavenNotation withGroup(java.lang.String group)

withModule

public MavenNotation withModule(java.lang.String module)

withVersion

public MavenNotation withVersion(@Nullable
                                 @Nullable java.lang.String version)

withClassifier

public MavenNotation withClassifier(@Nullable
                                    @Nullable java.lang.String classifier)

withExtension

public MavenNotation withExtension(java.lang.String extension)

toPath

public java.lang.String toPath()

Converts this MavenNotation to a path segment, either for a URL or File path.

Format: group(dot to slash)/module/version/module-version[-classifier].extension

Returns:

The path segment.

toFileName

public java.lang.String toFileName()

Converts this MavenNotation to a file name.

Format: module-version[-classifier].extension

Returns:

The file name.

toModulePath

public java.lang.String toModulePath()

Converts this MavenNotation to the module folder path.

Returns:

The path.

toFile

public java.io.File toFile(java.io.File dir)

Converts this MavenNotation to a file relative to the given base directory.

Parameters:

dir - The base directory.

Returns:

The new File.

toPath

public java.nio.file.Path toPath(java.nio.file.Path dir)

Converts this MavenNotation to a Path relative to the given base directory.

Parameters:

dir - The base directory.

Returns:

The Path.

toURL

public java.net.URL toURL(java.lang.String repo)

Converts this MavenNotation to a URL from the given URL.

Parameters:

repo - The repo.

Returns:

The new URL.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object