org.raml.pojotoraml

Class RamlAdjuster.Helper

java.lang.Object

org.raml.pojotoraml.RamlAdjuster.Helper

All Implemented Interfaces:

RamlAdjuster

Direct Known Subclasses:

AdditionalPropertiesAdjuster, ChangeTypeName

Enclosing interface:

RamlAdjuster

public static class RamlAdjuster.Helper
extends Object
implements RamlAdjuster

Nested Class Summary

Nested classes/interfaces inherited from interface org.raml.pojotoraml.RamlAdjuster

RamlAdjuster.Composite, RamlAdjuster.Helper

Field Summary

Fields inherited from interface org.raml.pojotoraml.RamlAdjuster

NULL_ADJUSTER

Constructor Summary

Constructors

Constructor and Description
Helper()

Method Summary

Modifier and Type	Method and Description
TypePropertyBuilder	adjustComposedProperty(TypeDeclarationBuilder typeDeclaration, Property property, TypePropertyBuilder typePropertyBuilder) You may change the property definition for a given composed type.
String	adjustEnumValue(Class<?> type, String name) If the type being adjusted is an enumeration, you may change the enumerated value's name.
TypeBuilder	adjustForUnknownType(Type type) Should you have a property than contains an unsupported type for RAML, you could handle here.
void	adjustForUnknownTypeInProperty(Type type, TypeBuilder typeBuilder, TypeDeclarationBuilder builder, Property property) Should you have a property than contains an unsupported type for RAML, you could handle here.
TypePropertyBuilder	adjustScalarProperty(TypeDeclarationBuilder typeDeclaration, Property property, TypePropertyBuilder typePropertyBuilder) You may change the property definition for a given scalar type.
TypeBuilder	adjustType(Type type, String typeName, TypeBuilder builder) Changes the type.
String	adjustTypeName(Class<?> aClass, String name) Allows you to change the name when used as a reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

Helper

public Helper()

Method Detail

adjustEnumValue

public String adjustEnumValue(Class<?> type,
                              String name)

Description copied from interface: RamlAdjuster

If the type being adjusted is an enumeration, you may change the enumerated value's name.

Specified by:

adjustEnumValue in interface RamlAdjuster

Returns:

adjustType

public TypeBuilder adjustType(Type type,
                              String typeName,
                              TypeBuilder builder)

Description copied from interface: RamlAdjuster

Changes the type. You may RAML information to the type builder (or change it entirely).

Specified by:

adjustType in interface RamlAdjuster

builder - a suggested builder. You can add to it and return this builder, or build a new one.

Returns:

adjustTypeName

public String adjustTypeName(Class<?> aClass,
                             String name)

Description copied from interface: RamlAdjuster

Allows you to change the name when used as a reference. In most cases, it should match what comes out of RamlAdjuster.adjustType(Type, String, TypeBuilder) should you overload both.

Specified by:

adjustTypeName in interface RamlAdjuster

name - a suggested type name. You may return it or change it. It may not be null.

Returns:

adjustScalarProperty

public TypePropertyBuilder adjustScalarProperty(TypeDeclarationBuilder typeDeclaration,
                                                Property property,
                                                TypePropertyBuilder typePropertyBuilder)

Description copied from interface: RamlAdjuster

You may change the property definition for a given scalar type.

Specified by:

adjustScalarProperty in interface RamlAdjuster

typePropertyBuilder - a suggested builder. You can add to it and return this builder, or build a new one.

Returns:

adjustComposedProperty

public TypePropertyBuilder adjustComposedProperty(TypeDeclarationBuilder typeDeclaration,
                                                  Property property,
                                                  TypePropertyBuilder typePropertyBuilder)

Description copied from interface: RamlAdjuster

You may change the property definition for a given composed type.

Specified by:

adjustComposedProperty in interface RamlAdjuster

typePropertyBuilder - a suggested builder. You can add to it and return this builder, or build a new one.

Returns:

adjustForUnknownType

public TypeBuilder adjustForUnknownType(Type type)

Description copied from interface: RamlAdjuster

Should you have a property than contains an unsupported type for RAML, you could handle here.

Specified by:

adjustForUnknownType in interface RamlAdjuster

Returns:

adjustForUnknownTypeInProperty

public void adjustForUnknownTypeInProperty(Type type,
                                           TypeBuilder typeBuilder,
                                           TypeDeclarationBuilder builder,
                                           Property property)

Description copied from interface: RamlAdjuster

Should you have a property than contains an unsupported type for RAML, you could handle here.

Specified by:

adjustForUnknownTypeInProperty in interface RamlAdjuster