org.sonatype.aether.util.metadata
Class DefaultMetadata

java.lang.Object
  extended by org.sonatype.aether.util.metadata.DefaultMetadata
All Implemented Interfaces:
Metadata

public final class DefaultMetadata
extends Object
implements Metadata

A basic metadata instance. Note: Instances of this class are immutable and the exposed mutators return new objects rather than changing the current instance.

Author:
Benjamin Bentmann

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.sonatype.aether.metadata.Metadata
Metadata.Nature
 
Constructor Summary
DefaultMetadata(String type, Metadata.Nature nature)
          Creates a new metadata for the repository root with the specific type and nature.
DefaultMetadata(String groupId, String type, Metadata.Nature nature)
          Creates a new metadata for the groupId level with the specific type and nature.
DefaultMetadata(String groupId, String artifactId, String type, Metadata.Nature nature)
          Creates a new metadata for the groupId:artifactId level with the specific type and nature.
DefaultMetadata(String groupId, String artifactId, String version, String type, Metadata.Nature nature)
          Creates a new metadata for the groupId:artifactId:version level with the specific type and nature.
DefaultMetadata(String groupId, String artifactId, String version, String type, Metadata.Nature nature, File file)
          Creates a new metadata for the groupId:artifactId:version level with the specific type and nature.
 
Method Summary
 String getArtifactId()
          Gets the artifact identifier of this metadata.
 File getFile()
          Gets the file of this metadata.
 String getGroupId()
          Gets the group identifier of this metadata.
 Metadata.Nature getNature()
          Gets the nature of this metadata.
 String getType()
          Gets the type of the metadata, e.g.
 String getVersion()
          Gets the version of this metadata.
 Metadata setFile(File file)
          Sets the file of the metadata.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DefaultMetadata

public DefaultMetadata(String type,
                       Metadata.Nature nature)
Creates a new metadata for the repository root with the specific type and nature.

Parameters:
type - The type of the metadata, e.g. "maven-metadata.xml", may be null.
nature - The nature of the metadata, must not be null.

DefaultMetadata

public DefaultMetadata(String groupId,
                       String type,
                       Metadata.Nature nature)
Creates a new metadata for the groupId level with the specific type and nature.

Parameters:
groupId - The group identifier to which this metadata applies, may be null.
type - The type of the metadata, e.g. "maven-metadata.xml", may be null.
nature - The nature of the metadata, must not be null.

DefaultMetadata

public DefaultMetadata(String groupId,
                       String artifactId,
                       String type,
                       Metadata.Nature nature)
Creates a new metadata for the groupId:artifactId level with the specific type and nature.

Parameters:
groupId - The group identifier to which this metadata applies, may be null.
artifactId - The artifact identifier to which this metadata applies, may be null.
type - The type of the metadata, e.g. "maven-metadata.xml", may be null.
nature - The nature of the metadata, must not be null.

DefaultMetadata

public DefaultMetadata(String groupId,
                       String artifactId,
                       String version,
                       String type,
                       Metadata.Nature nature)
Creates a new metadata for the groupId:artifactId:version level with the specific type and nature.

Parameters:
groupId - The group identifier to which this metadata applies, may be null.
artifactId - The artifact identifier to which this metadata applies, may be null.
version - The version to which this metadata applies, may be null.
type - The type of the metadata, e.g. "maven-metadata.xml", may be null.
nature - The nature of the metadata, must not be null.

DefaultMetadata

public DefaultMetadata(String groupId,
                       String artifactId,
                       String version,
                       String type,
                       Metadata.Nature nature,
                       File file)
Creates a new metadata for the groupId:artifactId:version level with the specific type and nature.

Parameters:
groupId - The group identifier to which this metadata applies, may be null.
artifactId - The artifact identifier to which this metadata applies, may be null.
version - The version to which this metadata applies, may be null.
type - The type of the metadata, e.g. "maven-metadata.xml", may be null.
nature - The nature of the metadata, must not be null.
file - The resolved file of the metadata, may be null.
Method Detail

getGroupId

public String getGroupId()
Description copied from interface: Metadata
Gets the group identifier of this metadata.

Specified by:
getGroupId in interface Metadata
Returns:
The group identifier or an empty string if the metadata applies to the entire repository, never null.

getArtifactId

public String getArtifactId()
Description copied from interface: Metadata
Gets the artifact identifier of this metadata.

Specified by:
getArtifactId in interface Metadata
Returns:
The artifact identifier or an empty string if the metadata applies to the groupId level only, never null.

getVersion

public String getVersion()
Description copied from interface: Metadata
Gets the version of this metadata.

Specified by:
getVersion in interface Metadata
Returns:
The version or an empty string if the metadata applies to the groupId:artifactId level only, never null.

getType

public String getType()
Description copied from interface: Metadata
Gets the type of the metadata, e.g. "maven-metadata.xml".

Specified by:
getType in interface Metadata
Returns:
The type of the metadata, never null.

getNature

public Metadata.Nature getNature()
Description copied from interface: Metadata
Gets the nature of this metadata. The nature indicates to what artifact versions the metadata refers.

Specified by:
getNature in interface Metadata
Returns:
The nature, never null.

getFile

public File getFile()
Description copied from interface: Metadata
Gets the file of this metadata. Note that only resolved metadata has a file associated with it.

Specified by:
getFile in interface Metadata
Returns:
The file or null if none.

setFile

public Metadata setFile(File file)
Description copied from interface: Metadata
Sets the file of the metadata.

Specified by:
setFile in interface Metadata
Parameters:
file - The file of the metadata, may be null
Returns:
The new metadata, never null.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2010-2012. All Rights Reserved.