org.apache.johnzon.mapper.converter

Class ClassConverter

java.lang.Object

org.apache.johnzon.mapper.converter.ClassConverter

All Implemented Interfaces:

Converter<java.lang.Class<?>>, MapperConverter

public class ClassConverter
extends java.lang.Object
implements Converter<java.lang.Class<?>>

Maps a Class to/from its name.

Deserializing a class name means loading the class the incoming document asks for, so this converter is not registered by default and must be registered explicitly - see MapperBuilder#addConverter - with the set of classes it is allowed to load. Both allow-lists default to empty, ie deserialization always fails until they are configured.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.johnzon.mapper.Converter

Converter.TypeAccess

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<java.lang.String>	allowedClasses
private java.util.Collection<java.lang.String>	allowedPrefixes

Constructor Summary

Constructors

Constructor and Description
ClassConverter() Serialization only, any incoming class name is rejected.
ClassConverter(java.util.Collection<java.lang.String> allowedClasses, java.util.Collection<java.lang.String> allowedPrefixes)

Method Summary

Modifier and Type	Method and Description
private static java.util.Collection<java.lang.String>	copy(java.util.Collection<java.lang.String> values)
java.lang.Class<?>	fromString(java.lang.String text)
private boolean	isAllowed(java.lang.String name)
java.lang.String	toString(java.lang.Class<?> instance)

Methods inherited from class java.lang.Object

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

Field Detail

allowedClasses

private final java.util.Collection<java.lang.String> allowedClasses

allowedPrefixes

private final java.util.Collection<java.lang.String> allowedPrefixes

Constructor Detail

ClassConverter

public ClassConverter()

Serialization only, any incoming class name is rejected.

ClassConverter

public ClassConverter(java.util.Collection<java.lang.String> allowedClasses,
                      java.util.Collection<java.lang.String> allowedPrefixes)

Parameters:

allowedClasses - the fully qualified names which can be loaded from the incoming document.

allowedPrefixes - the prefixes - generally packages - a class name must start with to be loaded.

Method Detail

toString

public java.lang.String toString(java.lang.Class<?> instance)

Specified by:

toString in interface Converter<java.lang.Class<?>>

fromString

public java.lang.Class<?> fromString(java.lang.String text)

Specified by:

fromString in interface Converter<java.lang.Class<?>>

isAllowed

private boolean isAllowed(java.lang.String name)

copy

private static java.util.Collection<java.lang.String> copy(java.util.Collection<java.lang.String> values)