GenerateMessageFileMojo (OpenDJ Doc Helper Maven Plugin 4.5.3 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.forgerock.opendj.maven.doc.GenerateMessageFileMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="generate-xml-messages-doc",
      defaultPhase=PRE_SITE)
public class GenerateMessageFileMojo
extends org.apache.maven.plugin.AbstractMojo
```
Generates an XML file of log messages found in properties files.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String KEY_FORM_MSG
  Message giving formatting rules for string keys.
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor Description
  
  GenerateMessageFileMojo()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  void execute()
  For maven exec plugin execution.
  - Methods inherited from class org.apache.maven.plugin.AbstractMojo
    getLog, getPluginContext, setLog, setPluginContext
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_FORM_MSG
```
public static final String KEY_FORM_MSG
```
    Message giving formatting rules for string keys.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GenerateMessageFileMojo
```
public GenerateMessageFileMojo()
```
- Method Detail
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
```
    For maven exec plugin execution. Generates for all included message files (sample.properties), a xml log ref file (log-ref-sample.xml)
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - if a problem occurs
    
    org.apache.maven.plugin.MojoFailureException - if a problem occurs