springfox.documentation.schema

Class AlternateTypeRule

java.lang.Object

springfox.documentation.schema.AlternateTypeRule

All Implemented Interfaces:

org.springframework.core.Ordered

public class AlternateTypeRule
extends java.lang.Object
implements org.springframework.core.Ordered

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.classmate.ResolvedType	alternate
protected int	order
protected com.fasterxml.classmate.ResolvedType	original

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AlternateTypeRule(com.fasterxml.classmate.ResolvedType original, com.fasterxml.classmate.ResolvedType alternate) Instantiates a new Alternate type rule.
AlternateTypeRule(com.fasterxml.classmate.ResolvedType original, com.fasterxml.classmate.ResolvedType alternate, int order) Instantiates a new Alternate type rule.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.classmate.ResolvedType	alternateFor(com.fasterxml.classmate.ResolvedType type) Provides alternate for supplier type.
boolean	appliesTo(com.fasterxml.classmate.ResolvedType type) Check if an alternate applies to type.
int	getOrder()

Methods inherited from class java.lang.Object

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

Field Detail

original

protected final com.fasterxml.classmate.ResolvedType original

alternate

protected final com.fasterxml.classmate.ResolvedType alternate

order

protected final int order

Constructor Detail

AlternateTypeRule

public AlternateTypeRule(com.fasterxml.classmate.ResolvedType original,
                         com.fasterxml.classmate.ResolvedType alternate)

Instantiates a new Alternate type rule.

Parameters:

original - the original type

alternate - the alternate type

AlternateTypeRule

public AlternateTypeRule(com.fasterxml.classmate.ResolvedType original,
                         com.fasterxml.classmate.ResolvedType alternate,
                         int order)

Instantiates a new Alternate type rule.

Parameters:

original - the original type

alternate - the alternate type

order - the order Ordered in which the rules are applied

Method Detail

alternateFor

public com.fasterxml.classmate.ResolvedType alternateFor(com.fasterxml.classmate.ResolvedType type)

Provides alternate for supplier type.

Parameters:

type - the type

Returns:

the alternate for the type

appliesTo

public boolean appliesTo(com.fasterxml.classmate.ResolvedType type)

Check if an alternate applies to type.

Parameters:

type - the source

Returns:

the boolean

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered