io.smallrye.openapi.runtime.scanner.dataobject

Class DataObjectDeque

java.lang.Object

io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque

public class DataObjectDeque
extends Object

Deque for exploring object graph.

Author:

Marc Savy <[email protected]>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataObjectDeque.PathEntry An entry on the object stack.

Constructor Summary

Constructors

Constructor and Description
DataObjectDeque(AugmentedIndexView index)

Method Summary

Modifier and Type	Method and Description
boolean	isEmpty()
DataObjectDeque.PathEntry	leafNode(DataObjectDeque.PathEntry parentNode, org.jboss.jandex.AnnotationTarget annotationTarget, org.jboss.jandex.Type classType, org.eclipse.microprofile.openapi.models.media.Schema schema) Create a leaf node (i.e.
DataObjectDeque.PathEntry	peek() Look at top of stack, but don't remove.
DataObjectDeque.PathEntry	pop() Remove and return top element from stack.
void	push(org.jboss.jandex.AnnotationTarget annotationTarget, @NotNull DataObjectDeque.PathEntry parentPathEntry, @NotNull org.jboss.jandex.Type type, @NotNull org.eclipse.microprofile.openapi.models.media.Schema schema) Create new entry and push to stack.
void	push(DataObjectDeque.PathEntry entry) Push entry to stack.
DataObjectDeque.PathEntry	rootNode(org.jboss.jandex.AnnotationTarget annotationTarget, org.jboss.jandex.ClassInfo classInfo, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema rootSchema) Create a root node (first entry in graph).
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataObjectDeque

public DataObjectDeque(AugmentedIndexView index)

Method Detail

size

public int size()

Returns:

the number of elements in this Deque

See Also:

Deque.size()

isEmpty

public boolean isEmpty()

Returns:

true if no elements in this Deque

See Also:

Collection.isEmpty()

peek

public DataObjectDeque.PathEntry peek()

Look at top of stack, but don't remove.

Returns:

the top element of the stack

See Also:

Deque.peek()

push

public void push(DataObjectDeque.PathEntry entry)

Push entry to stack. Does not perform cycle detection.

Parameters:

entry - the entry

See Also:

Deque.push(Object)

pop

public DataObjectDeque.PathEntry pop()

Remove and return top element from stack.

Returns:

the top element of the stack

See Also:

Deque.pop()

push

public void push(org.jboss.jandex.AnnotationTarget annotationTarget,
                 @NotNull
                 @NotNull DataObjectDeque.PathEntry parentPathEntry,
                 @NotNull
                 @NotNull org.jboss.jandex.Type type,
                 @NotNull
                 @NotNull org.eclipse.microprofile.openapi.models.media.Schema schema)

Create new entry and push to stack. Performs cycle detection.

Parameters:

annotationTarget - annotation target

parentPathEntry - parent path entry

type - the annotated type

schema - the schema corresponding to this position

rootNode

public DataObjectDeque.PathEntry rootNode(org.jboss.jandex.AnnotationTarget annotationTarget,
                                          org.jboss.jandex.ClassInfo classInfo,
                                          org.jboss.jandex.Type type,
                                          org.eclipse.microprofile.openapi.models.media.Schema rootSchema)

Create a root node (first entry in graph).

Parameters:

annotationTarget - annotation target

type - the annotated type

classInfo - the root classInfo

rootSchema - the schema corresponding to this position

Returns:

a new root node

leafNode

public DataObjectDeque.PathEntry leafNode(DataObjectDeque.PathEntry parentNode,
                                          org.jboss.jandex.AnnotationTarget annotationTarget,
                                          org.jboss.jandex.Type classType,
                                          org.eclipse.microprofile.openapi.models.media.Schema schema)

Create a leaf node (i.e. is attached to a parent)

Parameters:

parentNode - parent node

annotationTarget - annotation target

classType - the class type

schema - the schema

Returns:

the new leaf node