com.hedera.hashgraph.sdk.TokenNftInfoQuery Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
/*-
*
* Hedera Java SDK
*
* Copyright (C) 2020 - 2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.hedera.hashgraph.sdk;
import com.hedera.hashgraph.sdk.proto.Query;
import com.hedera.hashgraph.sdk.proto.QueryHeader;
import com.hedera.hashgraph.sdk.proto.Response;
import com.hedera.hashgraph.sdk.proto.ResponseHeader;
import com.hedera.hashgraph.sdk.proto.TokenGetNftInfoQuery;
import com.hedera.hashgraph.sdk.proto.TokenServiceGrpc;
import io.grpc.MethodDescriptor;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import javax.annotation.Nonnegative;
import javax.annotation.Nullable;
/**
* A query that returns information about a non-fungible token (NFT).
*
* You request the info for an NFT by specifying the NFT ID.
*
* See Hedera Documentation
*/
public class TokenNftInfoQuery extends com.hedera.hashgraph.sdk.Query, TokenNftInfoQuery> {
/**
* The ID of the non-fungible token in x.y.z format.
*/
@Nullable
private NftId nftId = null;
@Nullable
private TokenId tokenId = null;
/**
* The account ID of the current owner of the NFT
*/
@Nullable
private AccountId accountId = null;
private long start = 0;
private long end = 0;
/**
* Constructor.
*/
public TokenNftInfoQuery() {
}
/**
* Sets the NFT ID for which information is requested.
*
* @deprecated use {@link TokenNftInfoQuery#setNftId(NftId)} instead
* @param nftId The NftId to be set
* @return {@code this}
*/
@Deprecated
public TokenNftInfoQuery byNftId(NftId nftId) {
return setNftId(nftId);
}
/**
* Sets the NFT ID for which information is requested.
*
* @param nftId The NftId to be set
* @return {@code this}
*/
public TokenNftInfoQuery setNftId(NftId nftId) {
Objects.requireNonNull(nftId);
this.nftId = nftId;
return this;
}
/**
* Extract the nft id.
*
* @return the nft id
*/
@Nullable
public NftId getNftId() {
return nftId;
}
/**
* Sets the Token ID and the index range for which information is requested.
*
* @deprecated with no replacement
* @param tokenId The ID of the token for which information is requested
* @return {@code this}
*/
@Deprecated
public TokenNftInfoQuery byTokenId(TokenId tokenId) {
Objects.requireNonNull(tokenId);
this.tokenId = tokenId;
return this;
}
/**
* Extract the token id
*
* @return the tokenId
*/
@Nullable
@Deprecated
public TokenId getTokenId() {
return tokenId;
}
/**
* Sets the Account ID for which information is requested.
*
* @deprecated with no replacement
* @param accountId The Account ID for which information is requested
* @return {@code this}
*/
@Deprecated
public TokenNftInfoQuery byAccountId(AccountId accountId) {
Objects.requireNonNull(accountId);
this.accountId = accountId;
return this;
}
/**
* Get the Account ID for which information is requested
*
* @return the accountId
*/
@Nullable
@Deprecated
public AccountId getAccountId() {
return accountId;
}
/**
* Get the start of the index range for which information is requested
*
* @return the start
*/
@Deprecated
public long getStart() {
return start;
}
/**
* Sets the start of the index range for which information is requested.
*
* @deprecated with no replacement
* @param start The start index (inclusive) of the range of NFTs to query for. Value must be in the range [0; ownedNFTs-1]
* @return {@code this}
*/
@Deprecated
public TokenNftInfoQuery setStart(@Nonnegative long start) {
this.start = start;
return this;
}
/**
* Get the end of the index range for which information is requested
*
* @return the end
*/
@Deprecated
public long getEnd() {
return end;
}
/**
* Sets the end of the index range for which information is requested.
*
* @deprecated with no replacement
* @param end The end index (exclusive) of the range of NFTs to query for. Value must be in the range (start; ownedNFTs]
* @return {@code this}
*/
@Deprecated
public TokenNftInfoQuery setEnd(@Nonnegative long end) {
this.end = end;
return this;
}
@Override
void validateChecksums(Client client) throws BadEntityIdException {
if (nftId != null) {
nftId.tokenId.validateChecksum(client);
}
}
@Override
CompletableFuture onExecuteAsync(Client client) {
int modesEnabled = (nftId != null ? 1 : 0) + (tokenId != null ? 1 : 0) + (accountId != null ? 1 : 0);
if (modesEnabled > 1) {
throw new IllegalStateException("TokenNftInfoQuery must be one of byNftId, byTokenId, or byAccountId, but multiple of these modes have been selected");
} else if (modesEnabled == 0) {
throw new IllegalStateException("TokenNftInfoQuery must be one of byNftId, byTokenId, or byAccountId, but none of these modes have been selected");
}
return super.onExecuteAsync(client);
}
@Override
void onMakeRequest(com.hedera.hashgraph.sdk.proto.Query.Builder queryBuilder, QueryHeader header) {
var builder = TokenGetNftInfoQuery.newBuilder();
if(nftId != null) {
builder.setNftID(nftId.toProtobuf());
}
queryBuilder.setTokenGetNftInfo(builder.setHeader(header));
}
@Override
ResponseHeader mapResponseHeader(Response response) {
return response.getTokenGetNftInfo().getHeader();
}
@Override
QueryHeader mapRequestHeader(com.hedera.hashgraph.sdk.proto.Query request) {
return request.getTokenGetInfo().getHeader();
}
@Override
List mapResponse(Response response, AccountId nodeId, com.hedera.hashgraph.sdk.proto.Query request) {
return Collections.singletonList(TokenNftInfo.fromProtobuf(response.getTokenGetNftInfo().getNft()));
}
@Override
MethodDescriptor getMethodDescriptor() {
return TokenServiceGrpc.getGetTokenNftInfoMethod();
}
@Override
public CompletableFuture getCostAsync(Client client) {
// deleted accounts return a COST_ANSWER of zero which triggers `INSUFFICIENT_TX_FEE`
// if you set that as the query payment; 25 tinybar seems to be enough to get
// `Token_DELETED` back instead.
return super.getCostAsync(client).thenApply((cost) -> Hbar.fromTinybars(Math.max(cost.toTinybars(), 25)));
}
}