Package de.haumacher.msgbuf.generator

Class CodeConvention

java.lang.Object

de.haumacher.msgbuf.generator.CodeConvention

public class CodeConvention
extends Object

Utility methods defining technical names of generated classes.

Author:

Bernhard Haumacher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENUM_PROTOCOL_NAME_FUN	Enum method that returns the protocol string for the classifier.
static final String	ENUM_VALUE_OF_PROTOCOL	Enum method that resolves an enum value from a protocol string.
static final String	IMPL_PACKAGE_SUFFIX	The sub-package where to place implementations.

Constructor Summary

Constructors

Constructor	Description
CodeConvention()

Method Summary

Modifier and Type	Method	Description
static String	adderName(Field field)
static String	binaryConstant(Field field)
static String	classifierName(Constant constant)	The Java name of an enumeration classifier.
static String	constant(Field field)
static String	factoryName(MessageDef def)	Name of the factory method for the given MessageDef.
static String	fieldMemberName(Field field)
static Field	getField(MessageDef def, String name)
static String	getterName(Field field)
static String	hasName(Field field)
static String	implName(Definition def)
static String	implName(String name)
static String	internalAdderName(Field field)
static String	internalSetterName(Field field)
static String	jsonTypeConstant(MessageDef def)
static String	jsonTypeConstantRef(MessageDef def)
static String	mkBinaryTypeConstant(MessageDef def)
static String	name(Field field)
static String	packageName(QName packageName)
static String	qImplName(QName qName)
static String	qImplName(String packageSuffix, Definition def)
static String	qName(QName qName)
static String	qName(QName qName, Function<String,String> localNameConvention)
static String	qName(String packageSuffix, Definition def, Function<String,String> localNameConvention)
static String	qTypeName(CustomType def)
static String	qTypeName(Definition def)
static String	qTypeName(QName qName)
static String	readerName(Definition def)
static String	readerName(String name)
static String	readerNameContent(Definition def)
static String	readerNameContent(String name)
static String	removerName(Field field)
static String	setterName(Field field)
static String	suffix(Field field)
static String	typeKindConstant(MessageDef caseDef)
static String	typeName(Definition def)
static String	typeName(String name)

Methods inherited from class java.lang.Object

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

Field Details

ENUM_VALUE_OF_PROTOCOL

public static final String ENUM_VALUE_OF_PROTOCOL

Enum method that resolves an enum value from a protocol string.

See Also:

• Constant Field Values

ENUM_PROTOCOL_NAME_FUN

public static final String ENUM_PROTOCOL_NAME_FUN

Enum method that returns the protocol string for the classifier.

See Also:

• Constant Field Values

IMPL_PACKAGE_SUFFIX

public static final String IMPL_PACKAGE_SUFFIX

The sub-package where to place implementations.

See Also:

• Constant Field Values

Constructor Details

CodeConvention

public CodeConvention()

Method Details

qTypeName

public static String qTypeName(CustomType def)

qTypeName

public static String qTypeName(Definition def)

qImplName

public static String qImplName(String packageSuffix,
 Definition def)

qName

public static String qName(String packageSuffix,
 Definition def,
 Function<String,String> localNameConvention)

qTypeName

public static String qTypeName(QName qName)

qImplName

public static String qImplName(QName qName)

qName

public static String qName(QName qName,
 Function<String,String> localNameConvention)

typeName

public static String typeName(Definition def)

typeName

public static String typeName(String name)

implName

public static String implName(Definition def)

implName

public static String implName(String name)

suffix

public static String suffix(Field field)

binaryConstant

public static String binaryConstant(Field field)

constant

public static String constant(Field field)

factoryName

public static String factoryName(MessageDef def)

Name of the factory method for the given MessageDef.

Parameters:

def - The MessageDef to produce a factory name for.

getterName

public static String getterName(Field field)

adderName

public static String adderName(Field field)

internalAdderName

public static String internalAdderName(Field field)

removerName

public static String removerName(Field field)

hasName

public static String hasName(Field field)

name

public static String name(Field field)

setterName

public static String setterName(Field field)

internalSetterName

public static String internalSetterName(Field field)

readerName

public static String readerName(String name)

readerNameContent

public static String readerNameContent(String name)

readerName

public static String readerName(Definition def)

readerNameContent

public static String readerNameContent(Definition def)

packageName

public static String packageName(QName packageName)

qName

public static String qName(QName qName)

jsonTypeConstant

public static String jsonTypeConstant(MessageDef def)

jsonTypeConstantRef

public static String jsonTypeConstantRef(MessageDef def)

mkBinaryTypeConstant

public static String mkBinaryTypeConstant(MessageDef def)

fieldMemberName

public static String fieldMemberName(Field field)

typeKindConstant

public static String typeKindConstant(MessageDef caseDef)

getField

public static Field getField(MessageDef def,
 String name)

classifierName

public static String classifierName(Constant constant)

The Java name of an enumeration classifier.