Example (connect-utils-testing 0.3.106 API)

java.lang.Object
- com.github.jcustenborder.kafka.connect.utils.docs.Example

```
public class Example
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Example.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`Example.Type`

Constructor Summary

Constructors
Constructor and Description

Example()

Constructors
Constructor and Description
`Example()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`classDisplayName()`
`Class`	`className()`
`Class`	`getClassName()`
`Map<String,String>`	`getConfig()`
`String`	`getDanger()`
`String`	`getDescription()`
`String`	`getExampleJsonFile()`
`String`	`getExamplePrefix()`
`String`	`getExamplePropertiesFile()`
`String`	`getImportant()`
`String`	`getName()`
`String`	`getNote()`
`String`	`getResourceFile()`
`String`	`getTip()`
`Example.Type`	`getType()`
`String`	`getWarning()`
`static Example`	`load(Class cls, String resourceName)`
`String`	`resourceFile()`
`String`	`validateTestCaseName()`
`void`	`writeJsonExample(File parentFolder)`
`void`	`writePropertiesExample(File parentFolder)`

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

Constructor Detail
- Example
```
public Example()
```

Method Detail

getExamplePrefix
```
public String getExamplePrefix()
```

validateTestCaseName
```
public String validateTestCaseName()
```

getExampleJsonFile
```
public String getExampleJsonFile()
```

getExamplePropertiesFile

public String getExamplePropertiesFile()

load

public static Example load(Class cls,
                           String resourceName)

getType
```
public Example.Type getType()
```

getDanger
```
public String getDanger()
```

getImportant
```
public String getImportant()
```

getWarning
```
public String getWarning()
```

getTip
```
public String getTip()
```

resourceFile
```
public String resourceFile()
```

className
```
public Class className()
```

classDisplayName
```
public String classDisplayName()
```

getName
```
public String getName()
```

getDescription
```
public String getDescription()
```

getNote
```
public String getNote()
```

getClassName
```
public Class getClassName()
```

getResourceFile
```
public String getResourceFile()
```

getConfig
```
public Map<String,String> getConfig()
```

writePropertiesExample

public void writePropertiesExample(File parentFolder)
                            throws IOException

Throws:: IOException

writeJsonExample

public void writeJsonExample(File parentFolder)
                      throws IOException

Throws:: IOException

Class Example

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Example

Method Detail

getExamplePrefix

validateTestCaseName

getExampleJsonFile

getExamplePropertiesFile

load

getType

getDanger

getImportant

getWarning

getTip

resourceFile

className

classDisplayName

getName

getDescription

getNote

getClassName

getResourceFile

getConfig

writePropertiesExample

writeJsonExample