org.apache.maven.plugins.javadoc.options.JavadocOptions Maven / Gradle / Ivy
// =================== DO NOT EDIT THIS FILE ====================
// Generated by Modello 2.1.2,
// any modifications will be overwritten.
// ==============================================================
package org.apache.maven.plugins.javadoc.options;
/**
* Root class to contain all javadoc configuration options for
* inclusion in javadoc bundle archives.
*
* @version $Revision$ $Date$
*/
@SuppressWarnings( "all" )
public class JavadocOptions
implements java.io.Serializable
{
//--------------------------/
//- Class/Member Variables -/
//--------------------------/
/**
* Field groups.
*/
private java.util.List groups;
/**
* Field tags.
*/
private java.util.List tags;
/**
* Field docletArtifacts.
*/
private java.util.List docletArtifacts;
/**
* Field taglets.
*/
private java.util.List taglets;
/**
* Field offlineLinks.
*/
private java.util.List offlineLinks;
/**
* Field tagletArtifacts.
*/
private java.util.List tagletArtifacts;
/**
* Field resourcesArtifacts.
*/
private java.util.List resourcesArtifacts;
/**
* Field bootclasspathArtifacts.
*/
private java.util.List bootclasspathArtifacts;
/**
* Field links.
*/
private java.util.List links;
/**
* Field excludePackageNames.
*/
private java.util.List excludePackageNames;
/**
* Enables deep copying of the '**/doc-files'
* directories and the specific 'resources' directory.
*/
private boolean docfilesSubdirsUsed = false;
/**
* List of exclusion patterns separated by ':' for deep copying
* of the '**/doc-files' directories.
*/
private String excludedDocfilesSubdirs;
/**
*
* Path relative to project basedir where javadoc
* resources were located.
* This is mainly useful in multimodule builds
* where the reactor is still populated.
*
*/
private String javadocResourcesDirectory;
/**
* Field modelEncoding.
*/
private String modelEncoding = "UTF-8";
//-----------/
//- Methods -/
//-----------/
/**
* Method addBootclasspathArtifact.
*
* @param bootclasspathArtifact a bootclasspathArtifact object.
*/
public void addBootclasspathArtifact( BootclasspathArtifact bootclasspathArtifact )
{
getBootclasspathArtifacts().add( bootclasspathArtifact );
} //-- void addBootclasspathArtifact( BootclasspathArtifact )
/**
* Method addDocletArtifact.
*
* @param docletArtifact a docletArtifact object.
*/
public void addDocletArtifact( DocletArtifact docletArtifact )
{
getDocletArtifacts().add( docletArtifact );
} //-- void addDocletArtifact( DocletArtifact )
/**
* Method addExcludePackageName.
*
* @param string a string object.
*/
public void addExcludePackageName( String string )
{
getExcludePackageNames().add( string );
} //-- void addExcludePackageName( String )
/**
* Method addGroup.
*
* @param group a group object.
*/
public void addGroup( Group group )
{
getGroups().add( group );
} //-- void addGroup( Group )
/**
* Method addLink.
*
* @param string a string object.
*/
public void addLink( String string )
{
getLinks().add( string );
} //-- void addLink( String )
/**
* Method addOfflineLink.
*
* @param offlineLink a offlineLink object.
*/
public void addOfflineLink( OfflineLink offlineLink )
{
getOfflineLinks().add( offlineLink );
} //-- void addOfflineLink( OfflineLink )
/**
* Method addResourcesArtifact.
*
* @param resourcesArtifact a resourcesArtifact object.
*/
public void addResourcesArtifact( ResourcesArtifact resourcesArtifact )
{
getResourcesArtifacts().add( resourcesArtifact );
} //-- void addResourcesArtifact( ResourcesArtifact )
/**
* Method addTag.
*
* @param tag a tag object.
*/
public void addTag( Tag tag )
{
getTags().add( tag );
} //-- void addTag( Tag )
/**
* Method addTaglet.
*
* @param taglet a taglet object.
*/
public void addTaglet( Taglet taglet )
{
getTaglets().add( taglet );
} //-- void addTaglet( Taglet )
/**
* Method addTagletArtifact.
*
* @param tagletArtifact a tagletArtifact object.
*/
public void addTagletArtifact( TagletArtifact tagletArtifact )
{
getTagletArtifacts().add( tagletArtifact );
} //-- void addTagletArtifact( TagletArtifact )
/**
* Method getBootclasspathArtifacts.
*
* @return List
*/
public java.util.List getBootclasspathArtifacts()
{
if ( this.bootclasspathArtifacts == null )
{
this.bootclasspathArtifacts = new java.util.ArrayList();
}
return this.bootclasspathArtifacts;
} //-- java.util.List getBootclasspathArtifacts()
/**
* Method getDocletArtifacts.
*
* @return List
*/
public java.util.List getDocletArtifacts()
{
if ( this.docletArtifacts == null )
{
this.docletArtifacts = new java.util.ArrayList();
}
return this.docletArtifacts;
} //-- java.util.List getDocletArtifacts()
/**
* Method getExcludePackageNames.
*
* @return List
*/
public java.util.List getExcludePackageNames()
{
if ( this.excludePackageNames == null )
{
this.excludePackageNames = new java.util.ArrayList();
}
return this.excludePackageNames;
} //-- java.util.List getExcludePackageNames()
/**
* Get list of exclusion patterns separated by ':' for deep
* copying of the '**/doc-files' directories.
*
* @return String
*/
public String getExcludedDocfilesSubdirs()
{
return this.excludedDocfilesSubdirs;
} //-- String getExcludedDocfilesSubdirs()
/**
* Method getGroups.
*
* @return List
*/
public java.util.List getGroups()
{
if ( this.groups == null )
{
this.groups = new java.util.ArrayList();
}
return this.groups;
} //-- java.util.List getGroups()
/**
* Get path relative to project basedir where javadoc resources
* were located.
* This is mainly useful in multimodule builds
* where the reactor is still populated.
*
* @return String
*/
public String getJavadocResourcesDirectory()
{
return this.javadocResourcesDirectory;
} //-- String getJavadocResourcesDirectory()
/**
* Method getLinks.
*
* @return List
*/
public java.util.List getLinks()
{
if ( this.links == null )
{
this.links = new java.util.ArrayList();
}
return this.links;
} //-- java.util.List getLinks()
/**
* Get the modelEncoding field.
*
* @return String
*/
public String getModelEncoding()
{
return this.modelEncoding;
} //-- String getModelEncoding()
/**
* Method getOfflineLinks.
*
* @return List
*/
public java.util.List getOfflineLinks()
{
if ( this.offlineLinks == null )
{
this.offlineLinks = new java.util.ArrayList();
}
return this.offlineLinks;
} //-- java.util.List getOfflineLinks()
/**
* Method getResourcesArtifacts.
*
* @return List
*/
public java.util.List getResourcesArtifacts()
{
if ( this.resourcesArtifacts == null )
{
this.resourcesArtifacts = new java.util.ArrayList();
}
return this.resourcesArtifacts;
} //-- java.util.List getResourcesArtifacts()
/**
* Method getTagletArtifacts.
*
* @return List
*/
public java.util.List getTagletArtifacts()
{
if ( this.tagletArtifacts == null )
{
this.tagletArtifacts = new java.util.ArrayList();
}
return this.tagletArtifacts;
} //-- java.util.List getTagletArtifacts()
/**
* Method getTaglets.
*
* @return List
*/
public java.util.List getTaglets()
{
if ( this.taglets == null )
{
this.taglets = new java.util.ArrayList();
}
return this.taglets;
} //-- java.util.List getTaglets()
/**
* Method getTags.
*
* @return List
*/
public java.util.List getTags()
{
if ( this.tags == null )
{
this.tags = new java.util.ArrayList();
}
return this.tags;
} //-- java.util.List getTags()
/**
* Get enables deep copying of the '**/doc-files'
* directories and the specific 'resources' directory.
*
* @return boolean
*/
public boolean isDocfilesSubdirsUsed()
{
return this.docfilesSubdirsUsed;
} //-- boolean isDocfilesSubdirsUsed()
/**
* Method removeBootclasspathArtifact.
*
* @param bootclasspathArtifact a bootclasspathArtifact object.
*/
public void removeBootclasspathArtifact( BootclasspathArtifact bootclasspathArtifact )
{
getBootclasspathArtifacts().remove( bootclasspathArtifact );
} //-- void removeBootclasspathArtifact( BootclasspathArtifact )
/**
* Method removeDocletArtifact.
*
* @param docletArtifact a docletArtifact object.
*/
public void removeDocletArtifact( DocletArtifact docletArtifact )
{
getDocletArtifacts().remove( docletArtifact );
} //-- void removeDocletArtifact( DocletArtifact )
/**
* Method removeExcludePackageName.
*
* @param string a string object.
*/
public void removeExcludePackageName( String string )
{
getExcludePackageNames().remove( string );
} //-- void removeExcludePackageName( String )
/**
* Method removeGroup.
*
* @param group a group object.
*/
public void removeGroup( Group group )
{
getGroups().remove( group );
} //-- void removeGroup( Group )
/**
* Method removeLink.
*
* @param string a string object.
*/
public void removeLink( String string )
{
getLinks().remove( string );
} //-- void removeLink( String )
/**
* Method removeOfflineLink.
*
* @param offlineLink a offlineLink object.
*/
public void removeOfflineLink( OfflineLink offlineLink )
{
getOfflineLinks().remove( offlineLink );
} //-- void removeOfflineLink( OfflineLink )
/**
* Method removeResourcesArtifact.
*
* @param resourcesArtifact a resourcesArtifact object.
*/
public void removeResourcesArtifact( ResourcesArtifact resourcesArtifact )
{
getResourcesArtifacts().remove( resourcesArtifact );
} //-- void removeResourcesArtifact( ResourcesArtifact )
/**
* Method removeTag.
*
* @param tag a tag object.
*/
public void removeTag( Tag tag )
{
getTags().remove( tag );
} //-- void removeTag( Tag )
/**
* Method removeTaglet.
*
* @param taglet a taglet object.
*/
public void removeTaglet( Taglet taglet )
{
getTaglets().remove( taglet );
} //-- void removeTaglet( Taglet )
/**
* Method removeTagletArtifact.
*
* @param tagletArtifact a tagletArtifact object.
*/
public void removeTagletArtifact( TagletArtifact tagletArtifact )
{
getTagletArtifacts().remove( tagletArtifact );
} //-- void removeTagletArtifact( TagletArtifact )
/**
* Set a list of BootclasspathArtifact parameters.
*
* @param bootclasspathArtifacts a bootclasspathArtifacts object
*/
public void setBootclasspathArtifacts( java.util.List bootclasspathArtifacts )
{
this.bootclasspathArtifacts = bootclasspathArtifacts;
} //-- void setBootclasspathArtifacts( java.util.List )
/**
* Set enables deep copying of the '**/doc-files'
* directories and the specific 'resources' directory.
*
* @param docfilesSubdirsUsed a docfilesSubdirsUsed object.
*/
public void setDocfilesSubdirsUsed( boolean docfilesSubdirsUsed )
{
this.docfilesSubdirsUsed = docfilesSubdirsUsed;
} //-- void setDocfilesSubdirsUsed( boolean )
/**
* Set a list of DocletArtifact parameters.
*
* @param docletArtifacts a docletArtifacts object.
*/
public void setDocletArtifacts( java.util.List docletArtifacts )
{
this.docletArtifacts = docletArtifacts;
} //-- void setDocletArtifacts( java.util.List )
/**
* Set list of subpackage patterns to exclude from javadoc
* generation.
*
* @param excludePackageNames a excludePackageNames object.
*/
public void setExcludePackageNames( java.util.List excludePackageNames )
{
this.excludePackageNames = excludePackageNames;
} //-- void setExcludePackageNames( java.util.List )
/**
* Set list of exclusion patterns separated by ':' for deep
* copying of the '**/doc-files' directories.
*
* @param excludedDocfilesSubdirs a excludedDocfilesSubdirs
* object.
*/
public void setExcludedDocfilesSubdirs( String excludedDocfilesSubdirs )
{
this.excludedDocfilesSubdirs = excludedDocfilesSubdirs;
} //-- void setExcludedDocfilesSubdirs( String )
/**
* Set a list of Group parameters.
*
* @param groups a groups object.
*/
public void setGroups( java.util.List groups )
{
this.groups = groups;
} //-- void setGroups( java.util.List )
/**
* Set path relative to project basedir where javadoc resources
* were located.
* This is mainly useful in multimodule builds
* where the reactor is still populated.
*
* @param javadocResourcesDirectory a javadocResourcesDirectory
* object.
*/
public void setJavadocResourcesDirectory( String javadocResourcesDirectory )
{
this.javadocResourcesDirectory = javadocResourcesDirectory;
} //-- void setJavadocResourcesDirectory( String )
/**
* Set list of URLs to javadocs for external classes.
*
* @param links a links object.
*/
public void setLinks( java.util.List links )
{
this.links = links;
} //-- void setLinks( java.util.List )
/**
* Set the modelEncoding field.
*
* @param modelEncoding a modelEncoding object.
*/
public void setModelEncoding( String modelEncoding )
{
this.modelEncoding = modelEncoding;
} //-- void setModelEncoding( String )
/**
* Set a list of OfflineLink parameters.
*
* @param offlineLinks a offlineLinks object.
*/
public void setOfflineLinks( java.util.List offlineLinks )
{
this.offlineLinks = offlineLinks;
} //-- void setOfflineLinks( java.util.List )
/**
* Set a list of ResourcesArtifact parameters.
*
* @param resourcesArtifacts a resourcesArtifacts object.
*/
public void setResourcesArtifacts( java.util.List resourcesArtifacts )
{
this.resourcesArtifacts = resourcesArtifacts;
} //-- void setResourcesArtifacts( java.util.List )
/**
* Set a list of TagletArtifact parameters.
*
* @param tagletArtifacts a tagletArtifacts object.
*/
public void setTagletArtifacts( java.util.List tagletArtifacts )
{
this.tagletArtifacts = tagletArtifacts;
} //-- void setTagletArtifacts( java.util.List )
/**
* Set a list of Taglet parameters.
*
* @param taglets a taglets object.
*/
public void setTaglets( java.util.List taglets )
{
this.taglets = taglets;
} //-- void setTaglets( java.util.List )
/**
* Set a list of Tag parameters.
*
* @param tags a tags object.
*/
public void setTags( java.util.List tags )
{
this.tags = tags;
} //-- void setTags( java.util.List )
}