net.liftweb.util

TimeHelpers

trait TimeHelpers extends AnyRef

The TimeHelpers trait provide functions to create TimeSpans (an object representing an amount of time), to manage date formats or general utility functions (get the date for today, get year/month/day number,...)

go to: companion
linear super types: AnyRef, Any
known subclasses: TimeHelpers, Helpers
self type: TimeHelpers with ControlHelpers
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. TimeHelpers
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. class CalendarExtension extends AnyRef

    This class adds the setXXX methods to the Calendar class.

  2. class DateExtension extends AnyRef

    This class adds a noTime method the Date class, in order to get at Date object starting at 00:00

  3. class TimeSpan extends ConvertableToDate

    The TimeSpan class represents an amount of time.

  4. case class TimeSpanBuilder (len: Long) extends Product

    class building TimeSpans given an amount (len) and a method specify the time unit

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. object TimeSpan extends AnyRef

    The TimeSpan object provides class represents an amount of time.

  9. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. def boxParseInternetDate (dateString: String) : Box[Date]

    returns

    a date from a string using the internet format. Return the Epoch date if the parse is unsuccesfull

  11. def calcTime [T] (f: ⇒ T) : (Long, T)

    returns

    the time taken to evaluate f in millis and the result

  12. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  13. def currentYear : Int

    returns

    the current year

  14. def dateFormatter : SimpleDateFormat

    returns

    a standard format for the date yyyy/MM/dd

  15. def day (in: Date) : Int

    returns

    the day of month corresponding to the input date (1 based)

  16. def dayNow : Date

    returns

    the current Day as a Date object

      deprecated:
    1. use today instead

  17. def days (in: Long) : Long

    returns

    the number of millis corresponding to 'in' days

  18. def daysSinceEpoch : Long

    returns

    the number of days since epoch

  19. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  20. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  21. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  22. def formattedDateNow : String

    returns

    today's date formatted as yyyy/MM/dd

  23. def formattedTimeNow : String

    returns

    now's time formatted as HH:mm zzz

  24. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  25. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  26. def hourFormat (in: Date) : String

    returns

    the formatted time for a given Date

  27. def hourFormat : SimpleDateFormat

    returns

    a standard format HH:mm:ss

  28. def hours (in: Long) : Long

    returns

    the number of millis corresponding to 'in' hours

  29. implicit def intToTimeSpan (in: Int) : TimeSpan

    transforms an int to a TimeSpan object.

    transforms an int to a TimeSpan object. Usage: 3000 returns a TimeSpan of 3000L millis

    attributes: implicit
  30. implicit def intToTimeSpanBuilder (in: Int) : TimeSpanBuilder

    transforms an int to a TimeSpanBuilder object.

    transforms an int to a TimeSpanBuilder object. Usage: 3.seconds returns a TimeSpan of 3000L millis

    attributes: implicit
  31. def internetDateFormatter : SimpleDateFormat

    returns

    a formatter for internet dates (RFC822/1123) including: the day of week, the month, day of month, time and time zone

  32. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  33. def logTime [T] (f: ⇒ (String, T)) : T

    Call f and log the string returned together with the time taken in millis.

    Call f and log the string returned together with the time taken in millis.

    returns

    the second result from f

  34. def logTime [T] (msg: String)(f: ⇒ T) : T

    Log a message with the time taken in millis to do something and return the result

    Log a message with the time taken in millis to do something and return the result

    returns

    the result

  35. implicit def longToTimeSpan (in: Long) : TimeSpan

    transforms a long to a TimeSpan object.

    transforms a long to a TimeSpan object. Usage: 3000L returns a TimeSpan of 3000L millis

    attributes: implicit
  36. implicit def longToTimeSpanBuilder (in: Long) : TimeSpanBuilder

    transforms a long to a TimeSpanBuilder object.

    transforms a long to a TimeSpanBuilder object. Usage: 3L.seconds returns a TimeSpan of 3000L millis

    attributes: implicit
  37. def millis : Long

    returns

    the current number of millis: System.currentTimeMillis

  38. def millisToDays (millis: Long) : Long

    returns

    the number of days since epoch converted from millis

  39. def minutes (in: Long) : Long

    returns

    the number of millis corresponding to 'in' minutes

  40. def month (in: Date) : Int

    returns

    the month corresponding to today (0 based, relative to UTC)

  41. def nano : Long

    returns

    the current System.nanoTime()

  42. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  43. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  44. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  45. def now : Date

    returns

    the date object for now

  46. def nowAsInternetDate : String

    returns

    the current time as an internet date

  47. def parseInternetDate (dateString: String) : Date

    returns

    a date from a string using the internet format. Return the Epoch date if the parse is unsuccesfull

  48. def seconds (in: Long) : Long

    returns

    the number of millis corresponding to 'in' seconds

  49. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  50. def time (when: Long) : Date

    alias for new Date(millis)

    alias for new Date(millis)

  51. def timeFormatter : SimpleDateFormat

    returns

    a format for the time which includes the TimeZone: HH:mm zzz

  52. def timeNow : Date

    returns

    the current time as a Date object

      deprecated:
    1. use now instead

  53. implicit def toCalendarExtension (c: Calendar) : CalendarExtension

    implicit def used to add the setXXX methods to the Calendar class

    implicit def used to add the setXXX methods to the Calendar class

    attributes: implicit
  54. def toDate (in: Any) : Box[Date]

    returns

    a Full(date) or a failure if the input couldn't be translated to date (or Empty if the input is null)

  55. implicit def toDateExtension (d: Date) : DateExtension

    implicit def used to add the noTime method to the Date class

    implicit def used to add the noTime method to the Date class

    attributes: implicit
  56. def toInternetDate (in: Long) : String

    returns

    a date formatted with the internet format (from a number of millis)

  57. def toInternetDate (in: Date) : String

    returns

    a date formatted with the internet format

  58. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  59. def today : Calendar

    returns

    the Calendar object for today (the TimeZone is the local TimeZone). Its time is 00:00:00.000

  60. val utc : TimeZone

    The UTC TimeZone

    The UTC TimeZone

  61. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  62. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  63. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  64. def weeks (in: Long) : Long

    returns

    the number of millis corresponding to 'in' weeks

  65. def year (in: Date) : Int

    returns

    the year corresponding to today (relative to UTC)

Inherited from AnyRef

Inherited from Any