TransactionFactory (symbol-sdk-java 1.0.1 API)

java.lang.Object
- io.nem.symbol.sdk.model.transaction.TransactionFactory<T>

Type Parameters:

T - the transaction class an instance of this factory builds.

Direct Known Subclasses:

AccountAddressRestrictionTransactionFactory, AccountKeyLinkTransactionFactory, AccountMosaicRestrictionTransactionFactory, AccountOperationRestrictionTransactionFactory, AddressAliasTransactionFactory, AggregateTransactionFactory, HashLockTransactionFactory, MetadataTransactionFactory, MosaicAddressRestrictionTransactionFactory, MosaicAliasTransactionFactory, MosaicDefinitionTransactionFactory, MosaicGlobalRestrictionTransactionFactory, MosaicSupplyChangeTransactionFactory, MultisigAccountModificationTransactionFactory, NamespaceRegistrationTransactionFactory, NodeKeyLinkTransactionFactory, SecretLockTransactionFactory, SecretProofTransactionFactory, TransferTransactionFactory, VotingKeyLinkTransactionFactory, VrfKeyLinkTransactionFactory
```
public abstract class TransactionFactory<T extends Transaction>
extends java.lang.Object
```
The transaction factories allow you to create instances of transactions.
The benefits of using a factory instead of a constructor:
- Transactions can be immutable
- Better support for default values like deadline and max fee
- Better extensibility, fields can be added to Transaction without affecting the subclasses. It's not necessary to change subclasses constructors.
- Massive constructors are not necessary in the Transaction subclasses
- Mappers are easier to implement as top level mappers can set the top level transaction attributes via the factories without affecting the mapper subclasses
When a new transaction type is added, a new extension of this factory should be added too.

Constructor Summary

Constructors
Constructor and Description
`TransactionFactory(TransactionType type, int version, NetworkType networkType, Deadline deadline)` The constructor that sets the required and default attributes.
`TransactionFactory(TransactionType type, NetworkType networkType, Deadline deadline)` The constructor that sets the required and default attributes.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract T`	`build()`
`TransactionFactory<T>`	`calculateMaxFeeFromMultiplier(long feeMultiplier)` Builder method used to to re-calculate the max fee based on the configured feeMultiplier
`TransactionFactory<T>`	`deadline(Deadline deadline)` Builder method used to change the default deadline.
`Deadline`	`getDeadline()`
`java.util.Optional<TransactionGroup>`	`getGroup()`
`java.math.BigInteger`	`getMaxFee()`
`NetworkType`	`getNetworkType()`
`protected java.util.Optional<java.lang.Long>`	`getProvidedSize()`
`java.util.Optional<java.lang.String>`	`getSignature()`
`java.util.Optional<PublicAccount>`	`getSigner()`
`long`	`getSize()`
`java.util.Optional<TransactionInfo>`	`getTransactionInfo()`
`TransactionType`	`getType()`
`java.lang.Integer`	`getVersion()`
`TransactionFactory<T>`	`group(TransactionGroup group)` Builder method used to change the known transaction group.
`TransactionFactory<T>`	`maxFee(java.math.BigInteger maxFee)` Builder method used to change the default maxFee.
`TransactionFactory<T>`	`signature(java.lang.String signature)` Builder method used to set the signature.
`TransactionFactory<T>`	`signer(PublicAccount signer)` Builder method used to set the signer.
`TransactionFactory<T>`	`size(long size)` Builder method used to change the default size.
`TransactionFactory<T>`	`transactionInfo(TransactionInfo transactionInfo)` Builder method used to set the `TransactionInfo`.
`TransactionFactory<T>`	`version(java.lang.Integer version)` Builder method used to change the default version.

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

- Constructor Detail
  - TransactionFactory
```
public TransactionFactory(TransactionType type,
                          int version,
                          NetworkType networkType,
                          Deadline deadline)
```
    The constructor that sets the required and default attributes.
    
    Parameters:
    
    type - the transaction type, this field is generally defined in the sub classes.
    
    version - the version of the transaction
    
    networkType - the network type of this transaction.
    
    deadline - The deadline of the new transaction based on the server epoch adjustment time.
  - TransactionFactory
```
public TransactionFactory(TransactionType type,
                          NetworkType networkType,
                          Deadline deadline)
```
    The constructor that sets the required and default attributes.
    
    Parameters:
    
    type - the transaction type, this field is generally defined in the sub classes.
    
    networkType - the network type of this transaction.
    
    deadline - The deadline of the new transaction based on the server epoch adjustment time.
- Method Detail
  - deadline
```
public TransactionFactory<T> deadline(Deadline deadline)
```
    Builder method used to change the default deadline.
    
    Parameters:
    
    deadline - a new deadline
    
    Returns:
    
    this factory to continue building the transaction.
  - maxFee
```
public TransactionFactory<T> maxFee(java.math.BigInteger maxFee)
```
    Builder method used to change the default maxFee.
    
    Parameters:
    
    maxFee - a new maxFee
    
    Returns:
    
    this factory to continue building the transaction.
  - calculateMaxFeeFromMultiplier
```
public TransactionFactory<T> calculateMaxFeeFromMultiplier(long feeMultiplier)
```
    Builder method used to to re-calculate the max fee based on the configured feeMultiplier
    
    Parameters:
    
    feeMultiplier - the fee multiplier greater than 1
    
    Returns:
    
    this factory to continue building the transaction.
  - signature
```
public TransactionFactory<T> signature(java.lang.String signature)
```
    Builder method used to set the signature. This method is generally called from the rest api mappers.
    
    Parameters:
    
    signature - the signature.
    
    Returns:
    
    this factory to continue building the transaction.
  - signer
```
public TransactionFactory<T> signer(PublicAccount signer)
```
    Builder method used to set the signer. This method is generally called from the rest api mappers.
    
    Parameters:
    
    signer - the signer PublicAccount.
    
    Returns:
    
    this factory to continue building the transaction.
  - transactionInfo
```
public TransactionFactory<T> transactionInfo(TransactionInfo transactionInfo)
```
    Builder method used to set the TransactionInfo. This method is generally called from the rest api mappers.
    
    Parameters:
    
    transactionInfo - the TransactionInfo.
    
    Returns:
    
    this factory to continue building the transaction.
  - version
```
public TransactionFactory<T> version(java.lang.Integer version)
```
    Builder method used to change the default version. This method is generally called from the rest api mapper.
    
    Parameters:
    
    version - a new version
    
    Returns:
    
    this factory to continue building the transaction.
  - size
```
public TransactionFactory<T> size(long size)
```
    Builder method used to change the default size. This method is generally called from the rest api mapper.
    
    Parameters:
    
    size - the known size
    
    Returns:
    
    this factory to continue building the transaction.
  - group
```
public TransactionFactory<T> group(TransactionGroup group)
```
    Builder method used to change the known transaction group. This method is generally called from the rest api mapper.
    
    Parameters:
    
    group - a new group
    
    Returns:
    
    this factory to continue building the transaction.
  - getType
```
public TransactionType getType()
```
    Returns:
    
    the transaction type.
  - getNetworkType
```
public NetworkType getNetworkType()
```
    Returns:
    
    the netwirj type.
  - getVersion
```
public java.lang.Integer getVersion()
```
    Returns:
    
    the version.
  - getDeadline
```
public Deadline getDeadline()
```
    Returns:
    
    the transaction type.
  - getMaxFee
```
public java.math.BigInteger getMaxFee()
```
    Returns:
    
    the transaction type.
  - getSignature
```
public java.util.Optional<java.lang.String> getSignature()
```
    Returns:
    
    the transaction signaure if set.
  - getTransactionInfo
```
public java.util.Optional<TransactionInfo> getTransactionInfo()
```
    Returns:
    
    the transaction info if set.
  - getSigner
```
public java.util.Optional<PublicAccount> getSigner()
```
    Returns:
    
    the transaction signed if set.
  - getProvidedSize
```
protected java.util.Optional<java.lang.Long> getProvidedSize()
```
    Returns:
    
    the size from rest.
  - getSize
```
public long getSize()
```
    Returns:
    
    the size of the transaction that's going to be created. Useful when you want to update the maxFee of the transaction depending on its size.
  - getGroup
```
public java.util.Optional<TransactionGroup> getGroup()
```
    Returns:
    
    the set group.
  - build
```
public abstract T build()
```
    Returns:
    
    the new transaction immutable based on the configured factory.

Class TransactionFactory<T extends Transaction>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransactionFactory

TransactionFactory

Method Detail

deadline

maxFee

calculateMaxFeeFromMultiplier

signature

signer

transactionInfo

version

size

group

getType

getNetworkType

getVersion

getDeadline

getMaxFee

getSignature

getTransactionInfo

getSigner

getProvidedSize

getSize

getGroup

build