org.mapstruct.ap.model.common

Class ModelElement

java.lang.Object

org.mapstruct.ap.writer.FreeMarkerWritable

org.mapstruct.ap.model.common.ModelElement

All Implemented Interfaces:

Writable

Direct Known Subclasses:

Annotation, DecoratorConstructor, Field, GeneratedType, MappingMethod, Parameter, PropertyMapping, Type, TypeConversion

public abstract class ModelElement
extends FreeMarkerWritable

Base class of all model elements. Implements the Writable contract to write model elements into source code files.

Author:

Gunnar Morling

Nested Class Summary

Nested classes/interfaces inherited from interface org.mapstruct.ap.writer.Writable

Writable.Context

Constructor Summary

Constructors

Constructor and Description
ModelElement()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
void	write(Writable.Context context, Writer writer) Writes this element to the given writer.

Methods inherited from class org.mapstruct.ap.writer.FreeMarkerWritable

getTemplateName

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelElement

public ModelElement()

Method Detail

write

public void write(Writable.Context context,
         Writer writer)
           throws Exception

Description copied from interface: Writable

Writes this element to the given writer.

Specified by:

write in interface Writable

Overrides:

write in class FreeMarkerWritable

Parameters:

context - Provides additional data specific to the used implementation of the serialization mechanism.

writer - The writer to write this element to. Must not be closed by implementations.

Throws:

Exception

getImportTypes

public abstract Set<Type> getImportTypes()

Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.

Returns:

A set with type referenced by this model element. Must not be null.