org.raml.pojotoraml

Interface RamlAdjuster

All Known Implementing Classes:

AdditionalPropertiesAdjuster, ChangeTypeName, RamlAdjuster.Composite, RamlAdjuster.Helper

public interface RamlAdjuster

Created. There, you have it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RamlAdjuster.Composite
static class	RamlAdjuster.Helper

Field Summary

Fields

Modifier and Type	Field and Description
static RamlAdjuster	NULL_ADJUSTER

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.

Field Detail

NULL_ADJUSTER

static final RamlAdjuster NULL_ADJUSTER

Method Detail

adjustEnumValue

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

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

Parameters:

type -

name -

Returns:

adjustType

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

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

Parameters:

type -

typeName -

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

Returns:

adjustTypeName

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

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

Parameters:

aClass -

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

Returns:

adjustScalarProperty

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

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

Parameters:

typeDeclaration -

property -

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

Returns:

adjustComposedProperty

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

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

Parameters:

typeDeclaration -

property -

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

Returns:

adjustForUnknownType

TypeBuilder adjustForUnknownType(Type type)

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

Parameters:

type -

Returns:

adjustForUnknownTypeInProperty

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.

Parameters:

type -

typeBuilder -