Module org.apache.johnzon.mapper

Package org.apache.johnzon.mapper.converter

Class ClassConverter

java.lang.Object

org.apache.johnzon.mapper.converter.ClassConverter

All Implemented Interfaces:

Converter<Class<?>>, MapperConverter

public class ClassConverter
extends Object
implements Converter<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	Description
private final Collection<String>	allowedClasses
private final Collection<String>	allowedPrefixes

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

allowedClasses

private final Collection<String> allowedClasses

allowedPrefixes

private final Collection<String> allowedPrefixes

Constructor Details

ClassConverter

public ClassConverter()

Serialization only, any incoming class name is rejected.

ClassConverter

public ClassConverter(Collection<String> allowedClasses,
 Collection<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 Details

toString

public String toString(Class<?> instance)

Specified by:

toString in interface Converter<Class<?>>

fromString

public Class<?> fromString(String text)

Specified by:

fromString in interface Converter<Class<?>>

isAllowed

private boolean isAllowed(String name)

copy

private static Collection<String> copy(Collection<String> values)