LocalScmMetadataUtils (Maven SCM 1.11.2 API)

java.lang.Object
- org.apache.maven.scm.provider.local.metadata.LocalScmMetadataUtils

public class LocalScmMetadataUtils
extends java.lang.Object

Utils for dealing with LocalScmMetadata

Author:: Arne Degenring

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String FILENAME
The name of the metadata file

protected ScmLogger logger

Constructor Summary

Constructors
Constructor Description

LocalScmMetadataUtils(ScmLogger logger)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LocalScmMetadata`	`buildMetadata(java.io.File repository)`	Builds LocalScmMetadata based on contents of repository
`LocalScmMetadata`	`readMetadata(java.io.File dir)`	Reads metadata file from given directory.
`void`	`writeMetadata(java.io.File destinationDir, LocalScmMetadata metadata)`	Writes metadata file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILENAME
```
public static final java.lang.String FILENAME
```
    The name of the metadata file
    
    See Also:
    
    Constant Field Values
  - logger
```
protected final ScmLogger logger
```
- Constructor Detail
  - LocalScmMetadataUtils
```
public LocalScmMetadataUtils(ScmLogger logger)
```
- Method Detail
  - buildMetadata
```
public LocalScmMetadata buildMetadata(java.io.File repository)
                               throws java.io.IOException
```
    Builds LocalScmMetadata based on contents of repository
    
    Parameters:
    
    repository -
    
    Returns:
    
    Throws:
    
    java.io.IOException - if any
  - writeMetadata
```
public void writeMetadata(java.io.File destinationDir,
                          LocalScmMetadata metadata)
                   throws java.io.IOException
```
    Writes metadata file
    
    Parameters:
    
    destinationDir -
    
    metadata -
    
    Throws:
    
    java.io.IOException - if any
  - readMetadata
```
public LocalScmMetadata readMetadata(java.io.File dir)
```
    Reads metadata file from given directory.
    
    Parameters:
    
    dir - The directory that should contain the metadata file
    
    Returns:
    
    LocalScmMetadata or null in case of problems