Class AbstractCodeCopyMapper

java.lang.Object

io.github.mmm.code.api.copy.AbstractCodeCopyMapper

All Implemented Interfaces:

CodeCopyMapper

Direct Known Subclasses:

CodeCopyMapperDefault

public abstract class AbstractCodeCopyMapper
extends Object
implements CodeCopyMapper

Implementation of CodeCopyMapper for default mapping (copy only children).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor	Description
AbstractCodeCopyMapper()	The constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract <N extends CodeNode> N	doMap(N node, CodeCopyType type)
protected <N extends CodeNode> N	getMapping(N node)
<N extends CodeNode> N	map(N node, CodeCopyType type)
<N extends CodeNode> void	registerMapping(N source, N target)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CodeCopyMapper

mapName

Constructor Details

AbstractCodeCopyMapper

public AbstractCodeCopyMapper()

The constructor.

Method Details

map

public <N extends CodeNode> N map(N node,
 CodeCopyType type)

Specified by:

map in interface CodeCopyMapper

Type Parameters:

N - type of the given CodeNode.

Parameters:

node - the CodeNode to map. May be null for simplicity. In such case null has to be returned. Extend AbstractCodeCopyMapper to avoid mistakes.

type - the CodeCopyType defining the relation of the CodeNode to map.

Returns:

the given CodeNode or a mapped replacement (e.g. a copy of it).

getMapping

protected <N extends CodeNode> N getMapping(N node)

Type Parameters:

N - type of the given CodeNode.

Parameters:

node - the CodeNode to get from the existing mapping.

Returns:

the mapped CodeNode or null if no mapping is registered.

doMap

protected abstract <N extends CodeNode> N doMap(N node,
 CodeCopyType type)

Type Parameters:

N - type of the given CodeNode.

Parameters:

node - the CodeNode to map.

type - the CodeCopyType defining the relation of the CodeNode to map.

Returns:

the given CodeNode or a mapped replacement (e.g. a copy of it).

See Also:

• map(CodeNode, CodeCopyType)

registerMapping

public <N extends CodeNode> void registerMapping(N source,
 N target)

Type Parameters:

N - type of the given CodeNodes.

Parameters:

source - the original CodeNode to map.

target - the CodeNode copy to map to.