Module java4ever.framework

Package tech.deplant.java4ever.framework

Record Class OnchainConfig

java.lang.Object

java.lang.Record

tech.deplant.java4ever.framework.OnchainConfig

public record OnchainConfig(Artifact<String,String> artifact, OnchainConfig.OnchainInfo info)
extends Record

The type Onchain config.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OnchainConfig.OnchainInfo	The type Onchain info.
static final record	OnchainConfig.SavedContract	The type Saved contract.

Constructor Summary

Constructors

Constructor	Description
OnchainConfig(Artifact<String,String> artifact, OnchainConfig.OnchainInfo info)	Creates an instance of a OnchainConfig record class.

Method Summary

Modifier and Type	Method	Description
Contract	addContract(String name, Contract contract)	Adds OwnedContract object to config with a given name as a key.
Credentials	addKeys(String name, Credentials keys)	Add keys credentials.
Artifact<String,String>	artifact()	Returns the value of the artifact record component.
<T extends AbstractContract> T	contract(Class<T> clazz, int contextId, String contractName)	Contract t.
<T extends AbstractContract> T	contract(Class<T> clazz, int contextId, String contractName, String keysName)	Contract t.
static OnchainConfig	EMPTY(String serializationPath)	Empty onchain config.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
OnchainConfig.OnchainInfo	info()	Returns the value of the info record component.
Credentials	keys(String keysName)	Keys credentials.
static OnchainConfig	LOAD(String serializationPath)	Load onchain config.
static OnchainConfig	LOAD_IF_EXISTS(String serializationPath)	Load if exists onchain config.
void	sync()	Flushes this config to file on serializationPath()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OnchainConfig

public OnchainConfig(Artifact<String,String> artifact,
 OnchainConfig.OnchainInfo info)

Creates an instance of a OnchainConfig record class.

Parameters:

artifact - the value for the artifact record component

info - the value for the info record component

Method Details

LOAD_IF_EXISTS

public static OnchainConfig LOAD_IF_EXISTS(String serializationPath)
                                    throws IOException

Load if exists onchain config.

Parameters:

serializationPath - the serialization path

Returns:

the onchain config

Throws:

IOException - the io exception

EMPTY

public static OnchainConfig EMPTY(String serializationPath)
                           throws IOException

Empty onchain config.

Parameters:

serializationPath - the serialization path

Returns:

the onchain config

Throws:

IOException - the io exception

LOAD

public static OnchainConfig LOAD(String serializationPath)
                          throws com.fasterxml.jackson.core.JsonProcessingException

Load onchain config.

Parameters:

serializationPath - the serialization path

Returns:

the onchain config

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

keys

public Credentials keys(String keysName)

Keys credentials.

Parameters:

keysName - the keys name

Returns:

the credentials

contract

public <T extends AbstractContract> T contract(Class<T> clazz,
 int contextId,
 String contractName,
 String keysName)
                                        throws com.fasterxml.jackson.core.JsonProcessingException

Contract t.

Type Parameters:

T - the type parameter

Parameters:

clazz - the clazz

contextId - the context id

contractName - the contract name

keysName - the keys name

Returns:

the t

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

contract

public <T extends AbstractContract> T contract(Class<T> clazz,
 int contextId,
 String contractName)
                                        throws com.fasterxml.jackson.core.JsonProcessingException

Contract t.

Type Parameters:

T - the type parameter

Parameters:

clazz - the clazz

contextId - the context id

contractName - the contract name

Returns:

the t

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

addContract

public Contract addContract(String name,
 Contract contract)
                     throws IOException

Adds OwnedContract object to config with a given name as a key.

Parameters:

name - key for finding contract in config later

contract - contract object

Returns:

OwnedContract that we successfully putted to config

Throws:

IOException - can be thrown by the call of sync() method

addKeys

public Credentials addKeys(String name,
 Credentials keys)
                    throws IOException

Add keys credentials.

Parameters:

name - the name

keys - the keys

Returns:

the credentials

Throws:

IOException - the io exception

sync

public void sync()
          throws IOException

Flushes this config to file on serializationPath()

Throws:

IOException - can be thrown by work with File

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

artifact

public Artifact<String,String> artifact()

Returns the value of the artifact record component.

Returns:

the value of the artifact record component

info

public OnchainConfig.OnchainInfo info()

Returns the value of the info record component.

Returns:

the value of the info record component