com.hedera.hapi.node.transaction.GetByKeyQuery Maven / Gradle / Ivy
The newest version!
package com.hedera.hapi.node.transaction;
import com.hedera.hapi.node.base.*;
import com.hedera.pbj.runtime.*;
import com.hedera.pbj.runtime.io.*;
import com.hedera.pbj.runtime.io.buffer.*;
import com.hedera.pbj.runtime.io.stream.*;
import edu.umd.cs.findbugs.annotations.*;
import com.hedera.pbj.runtime.Codec;
import java.util.function.Consumer;
import edu.umd.cs.findbugs.annotations.Nullable;
import edu.umd.cs.findbugs.annotations.NonNull;
import static java.util.Objects.requireNonNull;
/**
* Get all accounts, claims, files, and smart contract instances whose associated keys include the
* given Key. The given Key must not be a contractID or a ThresholdKey. This is not yet implemented
* in the API, but will be in the future.
*
* @param header (1) Standard info sent from client to node, including the signed payment, and what kind of
* response is requested (cost, state proof, both, or neither).
* @param key (2) The key to search for. It must not contain a contractID nor a ThresholdSignature.
*/
public record GetByKeyQuery(
@Nullable QueryHeader header,
@Nullable Key key
) {
/** Protobuf codec for reading and writing in protobuf format */
public static final Codec PROTOBUF = new com.hedera.hapi.node.transaction.codec.GetByKeyQueryProtoCodec();
/** JSON codec for reading and writing in JSON format */
public static final JsonCodec JSON = new com.hedera.hapi.node.transaction.codec.GetByKeyQueryJsonCodec();
/** Default instance with all fields set to default values */
public static final GetByKeyQuery DEFAULT = newBuilder().build();
/**
* Create a pre-populated GetByKeyQuery.
*
* @param header (1) Standard info sent from client to node, including the signed payment, and what kind of
* response is requested (cost, state proof, both, or neither).,
* @param key (2) The key to search for. It must not contain a contractID nor a ThresholdSignature.
*/
public GetByKeyQuery(QueryHeader header, Key key) {
this.header = header;
this.key = key;
}
/**
* Override the default hashCode method for
* all other objects to make hashCode
*/
@Override
public int hashCode() {
int result = 1;
if (header != null && !header.equals(DEFAULT.header)) {
result = 31 * result + header.hashCode();
}
if (key != null && !key.equals(DEFAULT.key)) {
result = 31 * result + key.hashCode();
}
long hashCode = result;
// Shifts: 30, 27, 16, 20, 5, 18, 10, 24, 30
hashCode += hashCode << 30;
hashCode ^= hashCode >>> 27;
hashCode += hashCode << 16;
hashCode ^= hashCode >>> 20;
hashCode += hashCode << 5;
hashCode ^= hashCode >>> 18;
hashCode += hashCode << 10;
hashCode ^= hashCode >>> 24;
hashCode += hashCode << 30;
return (int)hashCode;
}
/**
* Override the default equals method for
*/
@Override
public boolean equals(Object that) {
if (that == null || this.getClass() != that.getClass()) {
return false;
}
GetByKeyQuery thatObj = (GetByKeyQuery)that;
if (header == null && thatObj.header != null) {
return false;
}
if (header != null && !header.equals(thatObj.header)) {
return false;
}
if (key == null && thatObj.key != null) {
return false;
}
if (key != null && !key.equals(thatObj.key)) {
return false;
}
return true;
}
/**
* Convenience method to check if the header has a value
*
* @return true of the header has a value
*/
public boolean hasHeader() {
return header != null;
}
/**
* Gets the value for header if it has a value, or else returns the default
* value for the type.
*
* @param defaultValue the default value to return if header is null
* @return the value for header if it has a value, or else returns the default value
*/
public QueryHeader headerOrElse(@NonNull final QueryHeader defaultValue) {
return hasHeader() ? header : defaultValue;
}
/**
* Gets the value for header if it has a value, or else throws an NPE.
* value for the type.
*
* @return the value for header if it has a value
* @throws NullPointerException if header is null
*/
public @NonNull QueryHeader headerOrThrow() {
return requireNonNull(header, "Field header is null");
}
/**
* Executes the supplied {@link Consumer} if, and only if, the header has a value
*
* @param ifPresent the {@link Consumer} to execute
*/
public void ifHeader(@NonNull final Consumer ifPresent) {
if (hasHeader()) {
ifPresent.accept(header);
}
}
/**
* Convenience method to check if the key has a value
*
* @return true of the key has a value
*/
public boolean hasKey() {
return key != null;
}
/**
* Gets the value for key if it has a value, or else returns the default
* value for the type.
*
* @param defaultValue the default value to return if key is null
* @return the value for key if it has a value, or else returns the default value
*/
public Key keyOrElse(@NonNull final Key defaultValue) {
return hasKey() ? key : defaultValue;
}
/**
* Gets the value for key if it has a value, or else throws an NPE.
* value for the type.
*
* @return the value for key if it has a value
* @throws NullPointerException if key is null
*/
public @NonNull Key keyOrThrow() {
return requireNonNull(key, "Field key is null");
}
/**
* Executes the supplied {@link Consumer} if, and only if, the key has a value
*
* @param ifPresent the {@link Consumer} to execute
*/
public void ifKey(@NonNull final Consumer ifPresent) {
if (hasKey()) {
ifPresent.accept(key);
}
}
/**
* Return a builder for building a copy of this model object. It will be pre-populated with all the data from this
* model object.
*
* @return a pre-populated builder
*/
public Builder copyBuilder() {
return new Builder(header, key);
}
/**
* Return a new builder for building a model object. This is just a shortcut for new Model.Builder().
*
* @return a new builder
*/
public static Builder newBuilder() {
return new Builder();
}
/**
* Builder class for easy creation, ideal for clean code where performance is not critical. In critical performance
* paths use the constructor directly.
*/
public static final class Builder {
@Nullable private QueryHeader header = null;
@Nullable private Key key = null;
/**
* Create an empty builder
*/
public Builder() {}
/**
* Create a pre-populated Builder.
*
* @param header (1) Standard info sent from client to node, including the signed payment, and what kind of
* response is requested (cost, state proof, both, or neither).,
* @param key (2) The key to search for. It must not contain a contractID nor a ThresholdSignature.
*/
public Builder(QueryHeader header, Key key) {
this.header = header;
this.key = key;
}
/**
* Build a new model record with data set on builder
*
* @return new model record with data set
*/
public GetByKeyQuery build() {
return new GetByKeyQuery(header, key);
}
/**
* (1) Standard info sent from client to node, including the signed payment, and what kind of
* response is requested (cost, state proof, both, or neither).
*
* @param header value to set
* @return builder to continue building with
*/
public Builder header(@Nullable QueryHeader header) {
this.header = header;
return this;
}
/**
* (1) Standard info sent from client to node, including the signed payment, and what kind of
* response is requested (cost, state proof, both, or neither).
*
* @param builder A pre-populated builder
* @return builder to continue building with
*/
public Builder header(QueryHeader.Builder builder) {
this.header = builder.build() ;
return this;
}
/**
* (2) The key to search for. It must not contain a contractID nor a ThresholdSignature.
*
* @param key value to set
* @return builder to continue building with
*/
public Builder key(@Nullable Key key) {
this.key = key;
return this;
}
/**
* (2) The key to search for. It must not contain a contractID nor a ThresholdSignature.
*
* @param builder A pre-populated builder
* @return builder to continue building with
*/
public Builder key(Key.Builder builder) {
this.key = builder.build() ;
return this;
}
}
}