Package io.openapiparser.model.v31

Class PathItem

java.lang.Object

io.openapiparser.Properties

io.openapiparser.model.v31.PathItem

All Implemented Interfaces:

Extensions, Reference

public class PathItem
extends Properties
implements Extensions, Reference

the Path Item object.

See specification: 4.8.9 Path Item Object

Field Summary

Fields inherited from class io.openapiparser.Properties

bucket, context

Constructor Summary

Constructors

Constructor	Description
PathItem(Context context, io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Summary

Modifier and Type	Method	Description
@Nullable Operation	getDelete()
@Nullable java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.Object>	getExtensions()	map of all extension properties.
@Nullable Operation	getGet()
@Nullable Operation	getHead()
@Nullable Operation	getOptions()
java.util.Collection<Parameter>	getParameters()
@Nullable Operation	getPatch()
@Nullable Operation	getPost()
@Nullable Operation	getPut()
java.lang.String	getRef()	$ref value.
PathItem	getRefObject()
java.util.Collection<Server>	getServers()
@Nullable java.lang.String	getSummary()
@Nullable Operation	getTrace()
boolean	isRef()	check if this is a $ref object.

Methods inherited from class io.openapiparser.Properties

getBooleanOrDefault, getBooleanOrFalse, getBooleanOrNull, getIntegerOrDefault, getIntegerOrNull, getMapObjectsOrEmpty, getMapObjectsOrEmpty, getMapSetStringsOrEmpty, getMapStringsOrEmpty, getNumberOrNull, getObjectOrNull, getObjectOrThrow, getObjectsOrEmpty, getRawValue, getRawValueOf, getRefObject, getRefObjectOrThrow, getStringOrNull, getStringOrThrow, getStringsOrEmpty, getStringsOrNull, getValueOf, hasProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

PathItem

public PathItem(Context context,
                io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Detail

isRef

public boolean isRef()

Description copied from interface: Reference

check if this is a $ref object.

Specified by:

isRef in interface Reference

Returns:

true if $ref else false.

getRef

public java.lang.String getRef()

Description copied from interface: Reference

$ref value. Should be guarded by Reference.isRef(). Throws if Reference.isRef() is false.

Specified by:

getRef in interface Reference

Returns:

ref

getRefObject

public PathItem getRefObject()

getSummary

public @Nullable java.lang.String getSummary()

Specified by:

getSummary in interface Reference

getDescription

public @Nullable java.lang.String getDescription()

Specified by:

getDescription in interface Reference

getGet

public @Nullable Operation getGet()

getPut

public @Nullable Operation getPut()

getPost

public @Nullable Operation getPost()

getDelete

public @Nullable Operation getDelete()

getOptions

public @Nullable Operation getOptions()

getHead

public @Nullable Operation getHead()

getPatch

public @Nullable Operation getPatch()

getTrace

public @Nullable Operation getTrace()

getServers

public java.util.Collection<Server> getServers()

getParameters

public java.util.Collection<Parameter> getParameters()

getExtensions

public java.util.Map<java.lang.String,java.lang.Object> getExtensions()

Description copied from interface: Extensions

map of all extension properties.

Specified by:

getExtensions in interface Extensions

Overrides:

getExtensions in class Properties

Returns:

map of extension properties