ScaleCodec 1.0.0 API

All Implemented Interfaces:


public final class ScaleCodec<Data extends Object>

Scale coded that handles converting objects to ByteArray and back

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`ScaleCodec.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private ScaleCodecSettings<Data>`	`settings`

Constructor Summary

Constructors
Constructor	Description
`ScaleCodec(ScaleCodecSettings<Data> settings)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final ScaleCodecSettings<Data>`	`getSettings()`	settings for a scale codec
`final Unit`	`setSettings(ScaleCodecSettings<Data> settings)`	settings for a scale codec
`final <T extends Any> T`	`fromScale(Data data, KType type)`	This method deserializes object of given Kotlin type
`final <T extends Any> T`	`fromScale(Data data, KClass<T> type)`	This method deserializes object of given Kotlin class
`final <T extends Any> Data`	`toScale(T obj, KType type)`	This method serializes object of given nonnull Kotlin type
`final <T extends Any> Data`	`toScale(T obj, KClass<T> type)`	This method serializes object of given nonnull Kotlin class
`final ScaleCodecTransaction<Data>`	`transaction()`	Grouped scale encoding

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

- Constructor Detail
  - ScaleCodec
```
ScaleCodec(ScaleCodecSettings<Data> settings)
```
- Method Detail
  - getSettings
```
 final ScaleCodecSettings<Data> getSettings()
```
    settings for a scale codec
  - setSettings
```
 final Unit setSettings(ScaleCodecSettings<Data> settings)
```
    settings for a scale codec
  - fromScale
```
 final <T extends Any> T fromScale(Data data, KType type)
```
    This method deserializes object of given Kotlin type
    
    Parameters:
    
    data - data to be deserialized
    
    type - a type to deserialize to
  - fromScale
```
 final <T extends Any> T fromScale(Data data, KClass<T> type)
```
    This method deserializes object of given Kotlin class
    
    Parameters:
    
    data - data to be deserialized
    
    type - a type to deserialize to
  - toScale
```
 final <T extends Any> Data toScale(T obj, KType type)
```
    This method serializes object of given nonnull Kotlin type
    
    Parameters:
    
    obj - a generic object to be deserialized
    
    type - a type to deserialize to
  - toScale
```
 final <T extends Any> Data toScale(T obj, KClass<T> type)
```
    This method serializes object of given nonnull Kotlin class
    
    Parameters:
    
    obj - a generic object to be serialized
  - transaction
```
 final ScaleCodecTransaction<Data> transaction()
```
    Grouped scale encoding