org.codehaus.mojo.license.model

Class Copyright

java.lang.Object

org.codehaus.mojo.license.model.Copyright

public class Copyright
extends Object

Model of a copyright.

Created on 1/8/14.

Since:

1.6

Author:

Tony Chemit

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COPYRIGHT_TO_STRING_FORMAT Copyright to string format.
protected int	firstYear Copyright first year of application.
protected String	holder Copyright holder.
protected Integer	lastYear Copyright last year of application (can be null if copyright is only on one year).

Constructor Summary

Constructors

Constructor and Description
Copyright()
Copyright(Copyright copyright)
Copyright(int firstYear, Integer lastYear, String holder)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Integer	getFirstYear()
String	getHolder()
Integer	getLastYear()
String	getText() Produces a string representation of the copyright.
String	getYears() Produces a string representation of the copyright year range.
int	hashCode()
static Copyright	newCopyright(Integer inceptionYear, Integer lastYear, String holder)
static Copyright	newCopyright(Integer inceptionYear, String holder)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT_TO_STRING_FORMAT

protected static final String COPYRIGHT_TO_STRING_FORMAT

Copyright to string format.

See Also:

Constant Field Values

holder

protected String holder

Copyright holder.

firstYear

protected int firstYear

Copyright first year of application.

lastYear

protected Integer lastYear

Copyright last year of application (can be null if copyright is only on one year).

Constructor Detail

Copyright

public Copyright()

Copyright

public Copyright(Copyright copyright)

Copyright

public Copyright(int firstYear,
         Integer lastYear,
         String holder)

Method Detail

newCopyright

public static Copyright newCopyright(Integer inceptionYear,
                     Integer lastYear,
                     String holder)

newCopyright

public static Copyright newCopyright(Integer inceptionYear,
                     String holder)

getHolder

public String getHolder()

Returns:

the copyright holder

getFirstYear

public Integer getFirstYear()

Returns:

the first year of the copyright

getLastYear

public Integer getLastYear()

Returns:

the last year of the copyright (if copyright affects only one year, can be equals to the getFirstYear()).

getYears

public String getYears()

Produces a string representation of the copyright year range.

If copyright acts on one year :

 2010
 

If copyright acts on more than one year :

 2010 - 2012
 

Returns:

the String representation of the copyright year range.

getText

public String getText()

Produces a string representation of the copyright.

If copyright acts on one year :

 Copyright (C) 2010 Holder
 

If copyright acts on more than one year :

 Copyright (C) 2010 - 2012 Holder
 

Returns:

the String representation of the copyright

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object