org.apache.maven.model.building
Class StringModelSource

java.lang.Object
  org.apache.maven.model.building.StringModelSource

All Implemented Interfaces:

ModelSource

public class StringModelSource
extends java.lang.Object
implements ModelSource

Wraps an ordinary CharSequence as a model source.

Author:

Benjamin Bentmann

Constructor Summary

StringModelSource(java.lang.CharSequence pom)
Creates a new model source backed by the specified string.

StringModelSource(java.lang.CharSequence pom, java.lang.String location)
Creates a new model source backed by the specified string.

Method Summary

java.io.InputStream	getInputStream() Gets a byte stream to the POM contents.
java.lang.String	getLocation() Provides a user-friendly hint about the location of the POM.
java.lang.String	getModel() Gets the character sequence of this model source.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StringModelSource

public StringModelSource(java.lang.CharSequence pom)

Creates a new model source backed by the specified string.

Parameters:

pom - The POM's string representation, may be empty or null.

StringModelSource

public StringModelSource(java.lang.CharSequence pom,
                         java.lang.String location)

Creates a new model source backed by the specified string.

Parameters:

pom - The POM's string representation, may be empty or null.

location - The location to report for this use, may be null.

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Description copied from interface: ModelSource

Gets a byte stream to the POM contents. Closing the returned stream is the responsibility of the caller.

Specified by:

getInputStream in interface ModelSource

Returns:

A byte stream to the POM contents, never null.

Throws:

java.io.IOException

getLocation

public java.lang.String getLocation()

Description copied from interface: ModelSource

Provides a user-friendly hint about the location of the POM. This could be a local file path, a URI or just an empty string. The intention is to assist users during error reporting.

Specified by:

getLocation in interface ModelSource

Returns:

A user-friendly hint about the location of the POM, never null.

getModel

public java.lang.String getModel()

Gets the character sequence of this model source.

Returns:

The underlying character stream, never null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object