A B C E F G H I O P R S U W

A

addProjectTokens(MavenProject, List<MavenProject>, String, List<String>) - Method in class org.kuali.maven.common.UrlBuilder

Add appropriate values to the list of tokens

afterExecution() - Method in class org.kuali.maven.mojo.BaseMojo

B

BaseMojo - Class in org.kuali.maven.mojo

Mojo essentials.

BaseMojo() - Constructor for class org.kuali.maven.mojo.BaseMojo

beforeExecution() - Method in class org.kuali.maven.mojo.BaseMojo

buildPath(MavenProject, List<MavenProject>) - Method in class org.kuali.maven.common.UrlBuilder

Traverse the hierarchy of projects and flatten it into a List

C

containsUnresolvedProperty(String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the string contains "${", false otherwise.

copy(String, String) - Method in class org.kuali.maven.common.ResourceUtils

Copy a URL location to the local file system

E

execute() - Method in class org.kuali.maven.mojo.BaseMojo

executeMojo() - Method in class org.kuali.maven.mojo.BaseMojo

Extractor - Class in org.kuali.maven.common

Extracts information contained in a pom and exposes it as project properties eg major version, scm type, scm url

Extractor() - Constructor for class org.kuali.maven.common.Extractor

F

FS - Static variable in class org.kuali.maven.mojo.BaseMojo

G

getDownloadBase() - Method in interface org.kuali.maven.common.SiteContext

getDownloadExternalPath() - Method in interface org.kuali.maven.common.SiteContext

getDownloadPath(MavenProject, SiteContext) - Method in class org.kuali.maven.common.UrlBuilder

Decide between "snapshot", "release", and "external"

getDownloadReleasePath() - Method in interface org.kuali.maven.common.SiteContext

getDownloadSnapshotPath() - Method in interface org.kuali.maven.common.SiteContext

getDownloadUrl(MavenProject, SiteContext) - Method in class org.kuali.maven.common.UrlBuilder

Return the fully qualified URL for downloading a Kuali artifact from Kuali's Maven repo.

getEncoding() - Method in class org.kuali.maven.mojo.BaseMojo

getEnvironmentProperties() - Method in class org.kuali.maven.common.PropertiesUtils

getGroupIdPath(String) - Method in class org.kuali.maven.common.UrlBuilder

Replace any dots with backslashes for the groupId passed in.

getInputStream(String) - Method in class org.kuali.maven.common.ResourceUtils

Given a location that can represent either a file on the file system or a Spring style resource, return an InputStream.

getMajorVersion(String) - Method in class org.kuali.maven.common.Extractor

getMavenProject(String) - Method in class org.kuali.maven.common.UrlBuilder

Given a GAV in the form [groupId]:[artifactId]:[version] return a MavenProject object that has groupId, artifactId, and version set

getMavenProjects(List<String>) - Method in class org.kuali.maven.common.UrlBuilder

Given a list of GAV's in the form [groupId]:[artifactId]:[version] return MavenProject objects with groupId, artifactId, and version set

getMavenSession() - Method in class org.kuali.maven.mojo.BaseMojo

getOrganizationGroupId() - Method in interface org.kuali.maven.common.SiteContext

getOrgPoms() - Method in interface org.kuali.maven.common.SiteContext

getPos(String) - Method in class org.kuali.maven.common.Extractor

getProject() - Method in class org.kuali.maven.mojo.BaseMojo

Returns the maven project.

getProjectPath(MavenProject) - Method in class org.kuali.maven.common.UrlBuilder

Return a List representing the complete hierarchy for this project.

getProperties(List<String>) - Method in class org.kuali.maven.common.PropertiesUtils

getProperties(String) - Method in class org.kuali.maven.common.PropertiesUtils

getPublicBase() - Method in interface org.kuali.maven.common.SiteContext

getPublicUrl(MavenProject, SiteContext) - Method in class org.kuali.maven.common.UrlBuilder

Return the fully qualified url for public access to the web site

getPublishBase() - Method in interface org.kuali.maven.common.SiteContext

getPublishUrl(MavenProject, SiteContext) - Method in class org.kuali.maven.common.UrlBuilder

Return the fully qualified url for publishing the web site

getResolvedValue(String, Properties) - Method in class org.kuali.maven.common.PropertiesUtils

getScmType(Scm) - Method in class org.kuali.maven.common.Extractor

getScmType(String) - Method in class org.kuali.maven.common.Extractor

getScmUrl(Scm) - Method in class org.kuali.maven.common.Extractor

getSettings() - Method in class org.kuali.maven.mojo.BaseMojo

getSitePath(MavenProject, List<MavenProject>, String) - Method in class org.kuali.maven.common.UrlBuilder

Return the portion of the url to the right of the hostname

getSiteUrl(MavenProject, SiteContext, String) - Method in class org.kuali.maven.common.UrlBuilder

Return a fully qualified url

getSnapshotSnippet() - Method in interface org.kuali.maven.common.SiteContext

getTokens(String) - Method in class org.kuali.maven.common.PropertiesUtils

getTokens(String, boolean) - Method in class org.kuali.maven.common.PropertiesUtils

getTopLevelTokens(MavenProject, String) - Method in class org.kuali.maven.common.UrlBuilder

Return the appropriate tokens for this top level project

getTrimmedGroupId(MavenProject, String) - Method in class org.kuali.maven.common.UrlBuilder

Return the non-redundant portion of the group id.

getUrlTokens(MavenProject, List<MavenProject>, String) - Method in class org.kuali.maven.common.UrlBuilder

Return a list of tokens representing url paths for this project

getUrlTokens(List<MavenProject>, List<MavenProject>, String) - Method in class org.kuali.maven.common.UrlBuilder

Return appropriate url tokens for the list of projects representing the path of projects from the highest level pom to our current project

H

handleMajorVersion(AbstractMojo, MavenProject, String) - Method in class org.kuali.maven.common.Extractor

handleScmType(AbstractMojo, MavenProject, String) - Method in class org.kuali.maven.common.Extractor

handleScmUrl(AbstractMojo, MavenProject, String) - Method in class org.kuali.maven.common.Extractor

I

isAppendArtifactId(MavenProject, String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the artifact id should be appended to the url for site publication.

isEmpty(Collection<?>) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the Collection passed in is null or size zero, false otherwise

isForceMojoExecution() - Method in class org.kuali.maven.mojo.BaseMojo

isInteger(char) - Method in class org.kuali.maven.common.Extractor

isMatch(MavenProject, List<MavenProject>) - Method in class org.kuali.maven.common.UrlBuilder

Return true if groupId + artifactId of "project" matches a groupId + artifactId from "targetProjects"

isMatch(MavenProject, MavenProject) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the groupId's and artifactId's match

isOrganizationProject(MavenProject, String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the group id of the project matches organization group id, false otherwise.

isSkip() - Method in class org.kuali.maven.mojo.BaseMojo

isSnapshot(String, String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if version contains snapshotSnippet (case insensitive)

isTargetGroupId(MavenProject, String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the groupId of the project positively matches the groupId passed in.

isTopLevelProject(MavenProject, List<MavenProject>) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the project has no parent, OR is one of the official org POM's.

isUnresolved(String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the string is, null, empty, or contains an unresolved property

isUrlMatch(String, String) - Method in class org.kuali.maven.common.UrlBuilder

Return true if the 2 urls are exactly the same or if the only thing different about them is a trailing slash

isXml(String) - Method in class org.kuali.maven.common.PropertiesUtils

O

org.kuali.maven.common - package org.kuali.maven.common

org.kuali.maven.mojo - package org.kuali.maven.mojo

P

PropertiesUtils - Class in org.kuali.maven.common

PropertiesUtils() - Constructor for class org.kuali.maven.common.PropertiesUtils

R

read(String) - Method in class org.kuali.maven.common.ResourceUtils

Read the contents of the URL location into a string

ResourceUtils - Class in org.kuali.maven.common

ResourceUtils() - Constructor for class org.kuali.maven.common.ResourceUtils

S

setEncoding(String) - Method in class org.kuali.maven.mojo.BaseMojo

setForceMojoExecution(boolean) - Method in class org.kuali.maven.mojo.BaseMojo

setMavenSession(MavenSession) - Method in class org.kuali.maven.mojo.BaseMojo

setProject(MavenProject) - Method in class org.kuali.maven.mojo.BaseMojo

setSettings(Settings) - Method in class org.kuali.maven.mojo.BaseMojo

setSkip(boolean) - Method in class org.kuali.maven.mojo.BaseMojo

SiteContext - Interface in org.kuali.maven.common

SKIP_PACKAGING_TYPE - Static variable in class org.kuali.maven.mojo.BaseMojo

skipMojo() - Method in class org.kuali.maven.mojo.BaseMojo

Determine if the mojo execution should get skipped.

U

UrlBuilder - Class in org.kuali.maven.common

Utility class for working with URL's related to Maven web site generation

UrlBuilder() - Constructor for class org.kuali.maven.common.UrlBuilder

W

write(String, String) - Method in class org.kuali.maven.common.ResourceUtils

Write the string to the file system

A B C E F G H I O P R S U W