All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.hedera.hapi.node.file.FileGetInfoQuery Maven / Gradle / Ivy

There is a newer version: 0.54.0
Show newest version
package com.hedera.hapi.node.file;

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 of the information about a file, except for its contents. When a file expires, it no
 * longer exists, and there will be no info about it, and the fileInfo field will be blank. If a
 * transaction or smart contract deletes the file, but it has not yet expired, then the fileInfo
 * field will be non-empty, the deleted field will be true, its size will be 0, and its contents
 * will be empty.
 *
 * @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 fileID (2) The file ID of the file for which information is requested
 */
public record FileGetInfoQuery(
    @Nullable QueryHeader header,
    @Nullable FileID fileID
) {
    /** Protobuf codec for reading and writing in protobuf format */
    public static final Codec PROTOBUF = new com.hedera.hapi.node.file.codec.FileGetInfoQueryProtoCodec();
    /** JSON codec for reading and writing in JSON format */
    public static final JsonCodec JSON = new com.hedera.hapi.node.file.codec.FileGetInfoQueryJsonCodec();
    
    /** Default instance with all fields set to default values */
    public static final FileGetInfoQuery DEFAULT = newBuilder().build();
    /**
     * Create a pre-populated FileGetInfoQuery.
     * 
     * @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 fileID (2) The file ID of the file for which information is requested
     */
    public FileGetInfoQuery(QueryHeader header, FileID fileID) {
        this.header = header;
        this.fileID = fileID;
    }
    /**
    * 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 (fileID != null && !fileID.equals(DEFAULT.fileID)) {
           result = 31 * result + fileID.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;
        }
        FileGetInfoQuery thatObj = (FileGetInfoQuery)that;
        if (header == null && thatObj.header != null) {
            return false;
        }
        if (header != null && !header.equals(thatObj.header)) {
            return false;
        }
        if (fileID == null && thatObj.fileID != null) {
            return false;
        }
        if (fileID != null && !fileID.equals(thatObj.fileID)) {
            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 fileID has a value
     *
     * @return true of the fileID has a value
     */
    public boolean hasFileID() {
    	return fileID != null;
    }
    
    /**
     * Gets the value for fileID if it has a value, or else returns the default
     * value for the type.
     *
     * @param defaultValue the default value to return if fileID is null
     * @return the value for fileID if it has a value, or else returns the default value
     */
    public FileID fileIDOrElse(@NonNull final FileID defaultValue) {
    	return hasFileID() ? fileID : defaultValue;
    }
    
    /**
     * Gets the value for fileID if it has a value, or else throws an NPE.
     * value for the type.
     *
     * @return the value for fileID if it has a value
     * @throws NullPointerException if fileID is null
     */
    public @NonNull FileID fileIDOrThrow() {
    	return requireNonNull(fileID, "Field fileID is null");
    }
    
    /**
     * Executes the supplied {@link Consumer} if, and only if, the fileID has a value
     *
     * @param ifPresent the {@link Consumer} to execute
     */
    public void ifFileID(@NonNull final Consumer ifPresent) {
    	if (hasFileID()) {
    		ifPresent.accept(fileID);
    	}
    }


    /**
     * 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, fileID);
    }
    
    /**
     * 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 FileID fileID = 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 fileID (2) The file ID of the file for which information is requested
         */
        public Builder(QueryHeader header, FileID fileID) {
            this.header = header;
            this.fileID = fileID;
        }
    
    
        /**
         * Build a new model record with data set on builder
         *
         * @return new model record with data set
         */
        public FileGetInfoQuery build() {
            return new FileGetInfoQuery(header, fileID);
        }
    
            /**
         * (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 file ID of the file for which information is requested
         *
         * @param fileID value to set
         * @return builder to continue building with
         */
        public Builder fileID(@Nullable FileID fileID) {
            this.fileID = fileID;
            return this;
        }
    
        /**
         * (2) The file ID of the file for which information is requested
         *
         * @param builder A pre-populated builder
         * @return builder to continue building with
         */
        public Builder fileID(FileID.Builder builder) {
            this.fileID = builder.build() ;
            return this;
        }
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy