com.xpn.xwiki.plugin.jodatime
Class JodaTimePluginApi

java.lang.Object
  extended by com.xpn.xwiki.api.Api
      extended by com.xpn.xwiki.plugin.PluginApi<JodaTimePlugin>
          extended by com.xpn.xwiki.plugin.jodatime.JodaTimePluginApi

public class JodaTimePluginApi
extends PluginApi<JodaTimePlugin>

Api for the JodaTimePlugin


Field Summary
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
JodaTimePluginApi(JodaTimePlugin plugin, XWikiContext context)
           
 
Method Summary
 DateTime getDateTime()
           
 DateTime getDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
           
 DateTime getDateTime(long instant)
           
 DateTimeFormatter getDateTimeFormatterForPattern(String pattern)
           
 DateTimeFormatter getDateTimeFormatterForStyle(String style)
           
 MutableDateTime getMutableDateTime()
           
 MutableDateTime getMutableDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
           
 MutableDateTime getMutableDateTime(long instant)
           
 DateTimeZone getServerTimezone()
           
 DateTimeZone getTimezone(int offsetHours)
           
 DateTimeZone getTimezone(int offsetHours, int offsetMinutes)
           
 DateTimeZone getTimezone(String locationOrOffset)
           
 DateTimeZone getUTCTimezone()
           
 
Methods inherited from class com.xpn.xwiki.plugin.PluginApi
getInternalPlugin, getProtectedPlugin, setPlugin
 
Methods inherited from class com.xpn.xwiki.api.Api
convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JodaTimePluginApi

public JodaTimePluginApi(JodaTimePlugin plugin,
                         XWikiContext context)
Method Detail

getDateTime

public DateTime getDateTime()
See Also:
DateTime.DateTime(), JodaTimePlugin.getDateTime()

getDateTime

public DateTime getDateTime(int year,
                            int monthOfYear,
                            int dayOfMonth,
                            int hourOfDay,
                            int minuteOfHour,
                            int secondOfMinute,
                            int millisOfSecond)
See Also:
DateTime.DateTime(int, int, int, int, int, int, int), JodaTimePlugin.getDateTime(int, int, int, int, int, int, int)

getDateTime

public DateTime getDateTime(long instant)
See Also:
DateTime.DateTime(long), JodaTimePlugin.getDateTime(long)

getMutableDateTime

public MutableDateTime getMutableDateTime()
See Also:
MutableDateTime.MutableDateTime(), JodaTimePlugin.getMutableDateTime()

getMutableDateTime

public MutableDateTime getMutableDateTime(int year,
                                          int monthOfYear,
                                          int dayOfMonth,
                                          int hourOfDay,
                                          int minuteOfHour,
                                          int secondOfMinute,
                                          int millisOfSecond)
See Also:
MutableDateTime.MutableDateTime(int, int, int, int, int, int, int), JodaTimePlugin.getMutableDateTime(int, int, int, int, int, int, int)

getMutableDateTime

public MutableDateTime getMutableDateTime(long instant)
See Also:
MutableDateTime.MutableDateTime(long), JodaTimePlugin.getMutableDateTime(long)

getDateTimeFormatterForPattern

public DateTimeFormatter getDateTimeFormatterForPattern(String pattern)
See Also:
DateTimeFormat.forPattern(String), JodaTimePlugin.getDateTimeFormatterForPattern(String, XWikiContext)

getDateTimeFormatterForStyle

public DateTimeFormatter getDateTimeFormatterForStyle(String style)
See Also:
DateTimeFormat.forStyle(String), JodaTimePlugin.getDateTimeFormatterForStyle(String, XWikiContext)

getServerTimezone

public DateTimeZone getServerTimezone()
See Also:
DateTimeZone.getDefault(), JodaTimePlugin.getServerTimezone()

getUTCTimezone

public DateTimeZone getUTCTimezone()
See Also:
DateTimeZone.UTC, JodaTimePlugin.getUTCTimezone()

getTimezone

public DateTimeZone getTimezone(String locationOrOffset)
See Also:
DateTimeZone.forID(String), JodaTimePlugin.getTimezone(String)

getTimezone

public DateTimeZone getTimezone(int offsetHours)
See Also:
DateTimeZone.forOffsetHours(int), JodaTimePlugin.getTimezone(int)

getTimezone

public DateTimeZone getTimezone(int offsetHours,
                                int offsetMinutes)
See Also:
DateTimeZone.forOffsetHoursMinutes(int, int), JodaTimePlugin.getTimezone(int, int)