Package com.mycila.maven.plugin.license.header

Class HeaderSource

java.lang.Object

com.mycila.maven.plugin.license.header.HeaderSource

Direct Known Subclasses:

HeaderSource.LiteralHeaderSource, HeaderSource.MultiLiteralHeaderSource, HeaderSource.MultiUrlHeaderSource, HeaderSource.UrlHeaderSource

public abstract class HeaderSource
extends Object

Provides an access to the license template text.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderSource.LiteralHeaderSource	A HeaderSource built from a license header template literal.
static class	HeaderSource.MultiLiteralHeaderSource	A HeaderSource built from multiple license header template literals.
static class	HeaderSource.MultiUrlHeaderSource	A HeaderSource loaded from multiple URL.
static class	HeaderSource.UrlHeaderSource	A HeaderSource loaded from a URL.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	content

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeaderSource(String content, boolean inline)

Method Summary

Modifier and Type	Method	Description
String	getContent()
abstract boolean	isFromUrl(URL location)	Retuns true if this HeaderSource was loaded from the URL given in the location parameter or false otherwise.
boolean	isInline()
static HeaderSource	of(Multi multi, String inlineHeader, String headerPath, String encoding, ResourceFinder finder)	Checking the params left to right, returns the first available HeaderSource that can be created.
static HeaderSource	of(String headerPath, String encoding, ResourceFinder finder)

Methods inherited from class java.lang.Object

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

Field Detail

content

protected final String content

Constructor Detail

HeaderSource

protected HeaderSource(String content,
                       boolean inline)

Method Detail

of

public static HeaderSource of(String headerPath,
                              String encoding,
                              ResourceFinder finder)

of

public static HeaderSource of(Multi multi,
                              String inlineHeader,
                              String headerPath,
                              String encoding,
                              ResourceFinder finder)

Checking the params left to right, returns the first available HeaderSource that can be created. If inlineHeader is not null returns a new HeaderSource.LiteralHeaderSource. Otherwise attempts to create a new HeaderSource.UrlHeaderSource out of headerPath and encoding.

Parameters:

multi - container for multi license, or null if single license

inlineHeader - the text of a license header template

headerPath - a path resolvable by the finder

encoding - the encoding to use when reading headerPath

finder - the ResourceFinder to use to resolve headerPath

Returns:

a new HeaderSource

getContent

public String getContent()

Returns:

the text of the license template

isInline

public boolean isInline()

Returns:

true if this HeaderSource was created from a string rather by loading the bits from an URL; false otherwise

isFromUrl

public abstract boolean isFromUrl(URL location)

Retuns true if this HeaderSource was loaded from the URL given in the location parameter or false otherwise.

Parameters:

location - the URL to tell if this HeaderSource was loaded from it

Returns:

true if this HeaderSource was loaded from the URL given in the location parameter or false otherwise