src/site/apt/usage.apt

 ------
 Usage
 ------
 Mark Hobson
 <markh@apache.org>
 ------
 19 May 2008
 ------

 ~~ Licensed to the Apache Software Foundation (ASF) under one
 ~~ or more contributor license agreements.  See the NOTICE file
 ~~ distributed with this work for additional information
 ~~ regarding copyright ownership.  The ASF licenses this file
 ~~ to you under the Apache License, Version 2.0 (the
 ~~ "License"); you may not use this file except in compliance
 ~~ with the License.  You may obtain a copy of the License at
 ~~
 ~~   http://www.apache.org/licenses/LICENSE-2.0
 ~~
 ~~ Unless required by applicable law or agreed to in writing,
 ~~ software distributed under the License is distributed on an
 ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 ~~ KIND, either express or implied.  See the License for the
 ~~ specific language governing permissions and limitations
 ~~ under the License.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html

Usage

 Maven Runtime allows introspection of Maven project metadata at runtime.  The main entry point is the
 {{{./apidocs/org/apache/maven/shared/runtime/MavenRuntime.html}MavenRuntime}} Plexus component.  The following example 
 describes the basic usage of the component:

---
/**
 * @component
 */
private MavenRuntime runtime;

public void printProjects() throws MavenRuntimeException
{
    ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
    
    for ( MavenProjectProperties properties : runtime.getProjectsProperties( classLoader ) )
    {
        System.out.println( properties );
    }
}
---

 This method will display the group id, artifact id and version of every Maven project within the current thread's
 context class loader.