net.raphimc.minecraftauth.step

Class AbstractStep.StepResult<P extends AbstractStep.StepResult<?>>

java.lang.Object

net.raphimc.minecraftauth.step.AbstractStep.StepResult<P>

Direct Known Subclasses:

AbstractStep.FirstStepResult, AbstractStep.InitialInput, BiMergeStep.StepResult, StepEduJWT.EduJWT, StepMCChain.MCChain, StepMCProfile.MCProfile, StepMCToken.MCToken, StepMsaToken.MsaToken, StepPlayerCertificates.PlayerCertificates, StepPlayFabToken.PlayFabToken, StepXblTitleToken.XblTitleToken, StepXblUserToken.XblUserToken, StepXblXstsToken.XblXsts

Enclosing class:

AbstractStep<I extends AbstractStep.StepResult<?>,O extends AbstractStep.StepResult<?>>

public abstract static class AbstractStep.StepResult<P extends AbstractStep.StepResult<?>>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StepResult()

Method Summary

Modifier and Type	Method and Description
abstract boolean	isExpired() Checks if this or any previous result is expired.
boolean	isExpiredOrOutdated() Checks if this or any previous result is expired or potentially outdated.
protected abstract P	prevResult()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepResult

public StepResult()

Method Detail

prevResult

protected abstract P prevResult()

isExpired

public abstract boolean isExpired()

Checks if this or any previous result is expired.
Results that have no expire time returned by their API are never considered expired.
If you want to minimize the amount of HTTP requests, you should only call AbstractStep.refresh(net.lenni0451.commons.httpclient.HttpClient, O) if this method returns true.
For certain use cases, like joining a Minecraft server, you want to make sure that the data is up-to-date, even if it is not expired yet. See isExpiredOrOutdated().

Returns:

true if this or any previous result is expired

isExpiredOrOutdated

public boolean isExpiredOrOutdated()

Checks if this or any previous result is expired or potentially outdated.
Results that have no expire time returned by their API are always considered outdated.
If you want the data in the result to be up-to-date, you should call AbstractStep.refresh(net.lenni0451.commons.httpclient.HttpClient, O) if this method returns true.

Returns:

true if this or any previous result is potentially outdated or expired