Package com.github.victools.jsonschema.generator.impl

Enum Class PropertySortUtils

java.lang.Object

java.lang.Enum<PropertySortUtils>

com.github.victools.jsonschema.generator.impl.PropertySortUtils

All Implemented Interfaces:

Serializable, Comparable<PropertySortUtils>, Constable

public enum PropertySortUtils
extends Enum<PropertySortUtils>

Utility class containing the declaration of the default property sort algorithm and its components.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<MemberScope<?,?>>	DEFAULT_PROPERTY_ORDER	Comparator sorting properties into the following groups and within each group alphabetically by their name.
static final Comparator<MemberScope<?,?>>	SORT_PROPERTIES_BY_NAME_ALPHABETICALLY	Comparator sorting properties: alphabetically by their name.
static final Comparator<MemberScope<?,?>>	SORT_PROPERTIES_FIELDS_BEFORE_METHODS	Comparator sorting properties: with fields before methods.

Method Summary

Modifier and Type	Method	Description
static PropertySortUtils	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertySortUtils[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

SORT_PROPERTIES_FIELDS_BEFORE_METHODS

public static final Comparator<MemberScope<?,?>> SORT_PROPERTIES_FIELDS_BEFORE_METHODS

Comparator sorting properties: with fields before methods.

SORT_PROPERTIES_BY_NAME_ALPHABETICALLY

public static final Comparator<MemberScope<?,?>> SORT_PROPERTIES_BY_NAME_ALPHABETICALLY

Comparator sorting properties: alphabetically by their name.

See Also:

• MemberScope.getSchemaPropertyName()

DEFAULT_PROPERTY_ORDER

public static final Comparator<MemberScope<?,?>> DEFAULT_PROPERTY_ORDER

Comparator sorting properties into the following groups and within each group alphabetically by their name.

1. instance fields
2. instance methods
3. static fields
4. static methods

See Also:

• MemberScope.getSchemaPropertyName()

Method Details

values

public static PropertySortUtils[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PropertySortUtils valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null