Example (openapi-parser 2023.2 API)

java.lang.Object
- io.openapiparser.Properties
- - io.openapiparser.model.v31.Example

All Implemented Interfaces:

Extensions, Reference
```
public class Example
extends Properties
implements Reference, Extensions
```
the Example object.
See specification: 4.8.19 Example Object

Field Summary
- Fields inherited from class io.openapiparser.Properties
  bucket, context

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@Nullable java.lang.String`	`getDescription()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtensions()`	map of all extension properties.
`@Nullable java.lang.String`	`getExternalValue()`
`java.lang.String`	`getRef()`	$ref value.
`@Nullable java.lang.String`	`getSummary()`
`@Nullable java.lang.Object`	`getValue()`
`boolean`	`isRef()`	check if this is a $ref object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Example
```
public Example(Context context,
               io.openapiprocessor.jsonschema.schema.Bucket bucket)
```
- Method Detail
  - isRef
```
public boolean isRef()
```
    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()
```
    $ref value. Should be guarded by Reference.isRef(). Throws if Reference.isRef() is false.
    
    Specified by:
    
    getRef in interface Reference
    
    Returns:
    
    ref
  - 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
  - getValue
```
public @Nullable java.lang.Object getValue()
```
  - getExternalValue
```
public @Nullable java.lang.String getExternalValue()
```
  - 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