Class TapLimit

java.lang.Object
uk.ac.starlink.vo.TapLimit

public class TapLimit extends Object
Characterises a limit which applies to a TAP service. This class can represent values encoded by the TAPRegExt DataLimits and TimeLimits element types.
Since:
8 Mar 2011
Author:
Mark Taylor
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Unit string used for a data limit of bytes ("byte").
    static final String
    Unit string used for a data limit of rows ("row").
    static final String
    Unit string used always for time limits ("seconds").
  • Constructor Summary

    Constructors
    Constructor
    Description
    TapLimit(long value, boolean isHard, String unit)
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the limit unit.
    long
    Returns the limit value.
    boolean
    Indicates whether this is a hard or soft (default) limit.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • TapLimit

      public TapLimit(long value, boolean isHard, String unit)
      Constructor.
      Parameters:
      value - limit value
      isHard - true for a hard limit, false for a default limit
      unit - unit for value
  • Method Details

    • getValue

      public long getValue()
      Returns the limit value.
      Returns:
      limit value
    • isHard

      public boolean isHard()
      Indicates whether this is a hard or soft (default) limit.
      Returns:
      true for hard limit, false for default limit
    • getUnit

      public String getUnit()
      Returns the limit unit. Should be SECONDS for time limits, and either ROWS or BYTES for data limits.
      Returns:
      limit unit
    • toString

      public String toString()
      Overrides:
      toString in class Object