com.github.i49.hibiscus.schema.internal

Class NamedPropertyImpl

java.lang.Object

com.github.i49.hibiscus.schema.internal.NamedPropertyImpl

All Implemented Interfaces:

NamedProperty, Property

public class NamedPropertyImpl
extends Object
implements NamedProperty

An implementation of NamedProperty interface.

Constructor Summary

Constructors

Constructor and Description
NamedPropertyImpl(String name, JsonType type, JsonType[] moreTypes, boolean required) Constructs this property.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of this property.
TypeSet	getTypeSet() Returns the set of types allowed for this property.
boolean	isRequired() Returns whether this property is required or not in the containing object.
boolean	matches(String name) Matches the given name to this property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.i49.hibiscus.schema.Property

isOptional

Constructor Detail

NamedPropertyImpl

public NamedPropertyImpl(String name,
                         JsonType type,
                         JsonType[] moreTypes,
                         boolean required)

Constructs this property.

Parameters:

name - the name of this property. Cannot be null.

type - the type of this property value. Cannot be null.

moreTypes - the other types allowed for this property value. Each type cannot be null.

required - whether this property is required or not in the containing object.

Throws:

SchemaException - if name is null or if one of types has the same TypeId as others or null.

Method Detail

getName

public String getName()

Description copied from interface: NamedProperty

Returns the name of this property.

Specified by:

getName in interface NamedProperty

Returns:

the name of this property.

getTypeSet

public TypeSet getTypeSet()

Description copied from interface: Property

Returns the set of types allowed for this property.

Specified by:

getTypeSet in interface Property

Returns:

the set of types allowed for this property.

isRequired

public boolean isRequired()

Description copied from interface: Property

Returns whether this property is required or not in the containing object.

Specified by:

isRequired in interface Property

Returns:

true if this property is required or false if this property is optional.

See Also:

Property.isOptional()

matches

public boolean matches(String name)

Description copied from interface: Property

Matches the given name to this property.

Specified by:

matches in interface Property

Parameters:

name - the name of the property which may match this property.

Returns:

true if the name given matched this property, false otherwise.