All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.opentripplanner.framework.token.Token Maven / Gradle / Ivy

    The newest version!
    package org.opentripplanner.framework.token;

import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;

/**
 * Given a schema definition and a token version this class holds the values for
 * all fields in a token.
 */
public class Token {

  private final TokenDefinition definition;
  private final List fieldValues;

  Token(TokenDefinition definition, List fieldValues) {
    this.definition = Objects.requireNonNull(definition);
    this.fieldValues = Objects.requireNonNull(fieldValues);
  }

  public int version() {
    return definition.version();
  }

  public boolean getBoolean(String fieldName) {
    return (boolean) get(fieldName, TokenType.BOOLEAN);
  }

  public byte getByte(String fieldName) {
    return (byte) get(fieldName, TokenType.BYTE);
  }

  public Duration getDuration(String fieldName) {
    return (Duration) get(fieldName, TokenType.DURATION);
  }

  public int getInt(String fieldName) {
    return (int) get(fieldName, TokenType.INT);
  }

  public String getString(String fieldName) {
    return (String) get(fieldName, TokenType.STRING);
  }

  /**
   * Be careful with enums. If values are added or deleted the backward/forward compatibility
   * is compromised. This method return an empty value if the enum does not exist.
   * 
    
   * To ensure that enum values are forward compatible the value must first be added, and then it
   * can not be used in a token before OTP is released and deployed. Then when the enum value
   * exist in the deployed server, then a new version of OTP can be rolled out which now can use
   * the new value.
   * 
    
   * To ensure backwards compatibility, enum values should be **deprecated**, not removed. The enum
   * value can only be deleted, when all tokens with the value has expired (depends on use-case).
   */
  public > Optional getEnum(String fieldName, Class enumClass) {
    try {
      return Optional.of(Enum.valueOf(enumClass, (String) get(fieldName, TokenType.ENUM)));
    } catch (IllegalArgumentException ignore) {
      return Optional.empty();
    }
  }

  public Instant getTimeInstant(String fieldName) {
    return (Instant) get(fieldName, TokenType.TIME_INSTANT);
  }

  private Object get(String fieldName, TokenType type) {
    return fieldValues.get(definition.getIndex(fieldName, type));
  }

  @Override
  public String toString() {
    return (
      "(v" +
      version() +
      ", " +
      fieldValues.stream().map(Objects::toString).collect(Collectors.joining(", ")) +
      ')'
    );
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy