Interface MavenEntityCore

All Known Implementing Classes:

MavenEntityCoreImpl

public interface MavenEntityCore

Interface for maven coordinates with an additional 'remainder' field. The remainder must be separated from the corrdinates using any of the following symbols:

• #
• /
• !

This allows for making references to files within a maven artifact, such as: groupId:artifactId:version:jar:classifier!/path/to/file.txt It also allows for retaining the remainder when transforming maven urns into relative IRIs and resolving them against a base IRI: Resolution of urn:mvn:groupId:artifactId:version:jar#dataset against https://example.org gives https://example.org/groupId/artifactId/artifactId-version.jar#dataset.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	URN_MVN

Method Summary

Modifier and Type	Method	Description
String	getArtifactId()
String	getClassifier()
static String	getFileNameSuffix(MavenEntityCore coord)	Returns a present classifier and type prefixed with '-' and '.', respectively.
String	getGroupId()
String	getRemainder()	The remainder is a string that follows the maven coordinate and should start with # or /
String	getType()
String	getVersion()
static MavenEntityCore	normalize(MavenEntityCore coord)	Return a copy where all nulls replaced by empty strings and all strings are trimmed
static MavenEntityCore	parse(String mvnIdOrUrn)	Parse a maven GAV pattern with colons.
static MavenEntityCore	parseId(String mvnIdEx)
static MavenEntityCore	parseUrn(String mvnUrn)
MavenEntityCore	setArtifactId(String artifactId)
MavenEntityCore	setClassifier(String classifier)
MavenEntityCore	setGroupId(String groupId)
MavenEntityCore	setRemainder(String remainder)
MavenEntityCore	setType(String type)
MavenEntityCore	setVersion(String version)
static String	toFileName(MavenEntityCore coord)	Return the file name: artifactId-version-classifier.type
static String	toPath(MavenEntityCore coord)	Return the path fraction: org/the/groupId/artifactId/version
static String	toPath(MavenEntityCore entity, String snapshotPrefix, String internalPrefix, String componentSeparator, boolean includePrefix, boolean includeDirectories, boolean includeFileName)
static String	toRelativeUrl(MavenEntityCore coord)	Return a complete relative URL for the given coordinate, such as: org/the/groupId/artifactId/version/artifactId-version-classifier.type
static String	toString(MavenEntityCore coord)

Field Details

URN_MVN

static final String URN_MVN

See Also:

• Constant Field Values

Method Details

getGroupId

String getGroupId()

setGroupId

MavenEntityCore setGroupId(String groupId)

getArtifactId

String getArtifactId()

setArtifactId

MavenEntityCore setArtifactId(String artifactId)

getVersion

String getVersion()

setVersion

MavenEntityCore setVersion(String version)

getType

String getType()

setType

MavenEntityCore setType(String type)

getClassifier

String getClassifier()

setClassifier

MavenEntityCore setClassifier(String classifier)

getRemainder

String getRemainder()

The remainder is a string that follows the maven coordinate and should start with # or /

setRemainder

MavenEntityCore setRemainder(String remainder)

normalize

static MavenEntityCore normalize(MavenEntityCore coord)

Return a copy where all nulls replaced by empty strings and all strings are trimmed

toString

static String toString(MavenEntityCore coord)

getFileNameSuffix

static String getFileNameSuffix(MavenEntityCore coord)

Returns a present classifier and type prefixed with '-' and '.', respectively. I.e.: [-classifier][.type]

toRelativeUrl

static String toRelativeUrl(MavenEntityCore coord)

Return a complete relative URL for the given coordinate, such as: org/the/groupId/artifactId/version/artifactId-version-classifier.type

toFileName

static String toFileName(MavenEntityCore coord)

Return the file name: artifactId-version-classifier.type

toPath

static String toPath(MavenEntityCore coord)

Return the path fraction: org/the/groupId/artifactId/version

parseId

static MavenEntityCore parseId(String mvnIdEx)

parseUrn

static MavenEntityCore parseUrn(String mvnUrn)

parse

static MavenEntityCore parse(String mvnIdOrUrn)

Parse a maven GAV pattern with colons. The pattern may be optionally prefixed with urn:mvn:

toPath

static String toPath(MavenEntityCore entity,
 String snapshotPrefix,
 String internalPrefix,
 String componentSeparator,
 boolean includePrefix,
 boolean includeDirectories,
 boolean includeFileName)