org.appops.tsgen.jackson.module.writer

Class EnumTypeToEnumPatternWriter

java.lang.Object

org.appops.tsgen.jackson.module.writer.EnumTypeToEnumPatternWriter

All Implemented Interfaces:

CustomAbstractTypeWriter

public class EnumTypeToEnumPatternWriter
extends java.lang.Object
implements CustomAbstractTypeWriter

Alternative to writing Java enum type to TypeScript enum type. Usefult, if You have following goals:
1) JavaScript object containing field of "enum" must contain enum name instead of ordinal value. This is good for several reasons: a) easy to understand JSON content b) doesn't mess things up, if enum order changes in backend.
2) You'd still like to write TypeScript as if You were using real enums - type safety, etc.
3) You need to use "reflection" (instanceof) to detect if field is "enum"

Constructor Summary

Constructors

Constructor and Description
EnumTypeToEnumPatternWriter()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(AbstractNamedType type, WriterPreferences preferences) Checks if writer preferences are valid for passed type or not.
void	writeDef(AbstractNamedType type, java.io.Writer writer, WriterPreferences preferences) Writes type definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumTypeToEnumPatternWriter

public EnumTypeToEnumPatternWriter()

Method Detail

accepts

public boolean accepts(AbstractNamedType type,
                       WriterPreferences preferences)

Description copied from interface: CustomAbstractTypeWriter

Checks if writer preferences are valid for passed type or not.

Specified by:

accepts in interface CustomAbstractTypeWriter

Parameters:

type - named type definition.

preferences - type writing preferences.

Returns:

true if this class should handle writing the type to Writer.

writeDef

public void writeDef(AbstractNamedType type,
                     java.io.Writer writer,
                     WriterPreferences preferences)
              throws java.io.IOException

Writes type definition.

Specified by:

writeDef in interface CustomAbstractTypeWriter

Parameters:

type - Type to be added into typescript.

writer - Typescript file writer.

preferences - Writing preperences and settings.

Throws:

java.io.IOException