org.apache.maven.plugin.resources.remote.RemoteResourcesBundle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-remote-resources-plugin Show documentation

Process resources packaged in JARs that have been deployed to a remote repository. The primary use case being satisfied is the consistent inclusion of common resources in a large set of projects. Maven projects at Apache use this plug-in to satisfy licensing requirements at Apache where each project must include license and notice files for each release.

The newest version!

// =================== DO NOT EDIT THIS FILE ====================
// Generated by Modello 2.4.0,
// any modifications will be overwritten.
// ==============================================================

package org.apache.maven.plugin.resources.remote;

/**
 * Root element of the remote-resources.xml file.
 * 
 * @version $Revision$ $Date$
 */
@SuppressWarnings( "all" )
public class RemoteResourcesBundle
    implements java.io.Serializable
{

      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * Field remoteResources.
     */
    private java.util.List remoteResources;

    /**
     * Source encoding of the remote resources contained in the
     * bundle.
     */
    private String sourceEncoding;

    /**
     * Field requiredProjectProperties.
     */
    private java.util.List requiredProjectProperties;

    /**
     * Field modelEncoding.
     */
    private String modelEncoding = "UTF-8";


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Method addRemoteResource.
     * 
     * @param string a string object.
     */
    public void addRemoteResource( String string )
    {
        getRemoteResources().add( string );
    } //-- void addRemoteResource( String )

    /**
     * Method addRequiredProjectProperty.
     * 
     * @param string a string object.
     */
    public void addRequiredProjectProperty( String string )
    {
        getRequiredProjectProperties().add( string );
    } //-- void addRequiredProjectProperty( String )

    /**
     * Get the modelEncoding field.
     * 
     * @return String
     */
    public String getModelEncoding()
    {
        return this.modelEncoding;
    } //-- String getModelEncoding()

    /**
     * Method getRemoteResources.
     * 
     * @return List
     */
    public java.util.List getRemoteResources()
    {
        if ( this.remoteResources == null )
        {
            this.remoteResources = new java.util.ArrayList();
        }

        return this.remoteResources;
    } //-- java.util.List getRemoteResources()

    /**
     * Method getRequiredProjectProperties.
     * 
     * @return List
     */
    public java.util.List getRequiredProjectProperties()
    {
        if ( this.requiredProjectProperties == null )
        {
            this.requiredProjectProperties = new java.util.ArrayList();
        }

        return this.requiredProjectProperties;
    } //-- java.util.List getRequiredProjectProperties()

    /**
     * Get source encoding of the remote resources contained in the
     * bundle.
     * 
     * @return String
     */
    public String getSourceEncoding()
    {
        return this.sourceEncoding;
    } //-- String getSourceEncoding()

    /**
     * Method removeRemoteResource.
     * 
     * @param string a string object.
     */
    public void removeRemoteResource( String string )
    {
        getRemoteResources().remove( string );
    } //-- void removeRemoteResource( String )

    /**
     * Method removeRequiredProjectProperty.
     * 
     * @param string a string object.
     */
    public void removeRequiredProjectProperty( String string )
    {
        getRequiredProjectProperties().remove( string );
    } //-- void removeRequiredProjectProperty( String )

    /**
     * Set the modelEncoding field.
     * 
     * @param modelEncoding a modelEncoding object.
     */
    public void setModelEncoding( String modelEncoding )
    {
        this.modelEncoding = modelEncoding;
    } //-- void setModelEncoding( String )

    /**
     * Set remote resources that are contained in a remote
     * resources bundle.
     * 
     * @param remoteResources a remoteResources object.
     */
    public void setRemoteResources( java.util.List remoteResources )
    {
        this.remoteResources = remoteResources;
    } //-- void setRemoteResources( java.util.List )

    /**
     * Set project properties needed to process Velocity template
     * by this resource bundle.
     * 
     * @param requiredProjectProperties a requiredProjectProperties
     * object.
     */
    public void setRequiredProjectProperties( java.util.List requiredProjectProperties )
    {
        this.requiredProjectProperties = requiredProjectProperties;
    } //-- void setRequiredProjectProperties( java.util.List )

    /**
     * Set source encoding of the remote resources contained in the
     * bundle.
     * 
     * @param sourceEncoding a sourceEncoding object.
     */
    public void setSourceEncoding( String sourceEncoding )
    {
        this.sourceEncoding = sourceEncoding;
    } //-- void setSourceEncoding( String )

}