org.apache.maven.api.model

Class Organization

java.lang.Object

org.apache.maven.api.model.Organization

All Implemented Interfaces:

Serializable, InputLocationTracker

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class Organization
extends Object
implements Serializable, InputLocationTracker

Specifies the organization that produces this project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Organization.Builder Builder class used to create Organization instances.

Method Summary

Modifier and Type	Method and Description
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getName() The full name of the organization.
String	getUrl() The URL to the organization's home page.
static Organization.Builder	newBuilder() Creates a new Organization builder instance.
static Organization.Builder	newBuilder(boolean withDefaults) Creates a new Organization builder instance using default values or not.
static Organization.Builder	newBuilder(Organization from) Creates a new Organization builder instance using the specified object as a basis.
static Organization.Builder	newBuilder(Organization from, boolean forceCopy) Creates a new Organization builder instance using the specified object as a basis.
static Organization	newInstance() Creates a new Organization instance.
static Organization	newInstance(boolean withDefaults) Creates a new Organization instance using default values or not.
Organization.Builder	with() Creates a new builder with this object as the basis.
Organization	withName(String name) Creates a new Organization instance using the specified name.
Organization	withUrl(String url) Creates a new Organization instance using the specified url.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

The full name of the organization.

Returns:

a String

getUrl

public String getUrl()

The URL to the organization's home page.

Returns:

a String

getLocation

public InputLocation getLocation(Object key)

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

with

@Nonnull
public Organization.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withName

@Nonnull
public Organization withName(String name)

Creates a new Organization instance using the specified name.

Parameters:

name - the new String to use

Returns:

a Organization with the specified name

withUrl

@Nonnull
public Organization withUrl(String url)

Creates a new Organization instance using the specified url.

Parameters:

url - the new String to use

Returns:

a Organization with the specified url

newInstance

@Nonnull
public static Organization newInstance()

Creates a new Organization instance. Equivalent to newInstance( true ).

Returns:

a new Organization

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Organization newInstance(boolean withDefaults)

Creates a new Organization instance using default values or not. Equivalent to newBuilder( withDefaults ).build().

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Organization

newBuilder

@Nonnull
public static Organization.Builder newBuilder()

Creates a new Organization builder instance. Equivalent to newBuilder( true ).

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

@Nonnull
public static Organization.Builder newBuilder(boolean withDefaults)

Creates a new Organization builder instance using default values or not.

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Builder

newBuilder

@Nonnull
public static Organization.Builder newBuilder(Organization from)

Creates a new Organization builder instance using the specified object as a basis. Equivalent to newBuilder( from, false ).

Parameters:

from - the Organization instance to use as a basis

Returns:

a new Builder

newBuilder

@Nonnull
public static Organization.Builder newBuilder(Organization from,
                                                       boolean forceCopy)

Creates a new Organization builder instance using the specified object as a basis.

Parameters:

from - the Organization instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder