Package com.xpn.xwiki.plugin.jodatime
Class JodaTimePlugin
- java.lang.Object
-
- com.xpn.xwiki.plugin.XWikiDefaultPlugin
-
- com.xpn.xwiki.plugin.jodatime.JodaTimePlugin
-
- All Implemented Interfaces:
XWikiPluginInterface
public class JodaTimePlugin extends XWikiDefaultPlugin
Plugin for manipulating dates from velocity scripts inside xwiki documents. It is based on the JodaTime framework, a quality replacement for the Java date and time classes.- See Also:
JodaTimePluginApi
-
-
Constructor Summary
Constructors Constructor Description JodaTimePlugin(String name, String className, XWikiContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.joda.time.DateTime
getDateTime()
org.joda.time.DateTime
getDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
org.joda.time.DateTime
getDateTime(long instant)
org.joda.time.format.DateTimeFormatter
getDateTimeFormatterForPattern(String pattern, XWikiContext context)
org.joda.time.format.DateTimeFormatter
getDateTimeFormatterForStyle(String style, XWikiContext context)
org.joda.time.Duration
getDuration(long millis)
org.joda.time.Duration
getDuration(org.joda.time.ReadableInstant from, org.joda.time.ReadableInstant to)
org.joda.time.format.DateTimeFormatter
getISODateTimeFormatter()
org.joda.time.MutableDateTime
getMutableDateTime()
org.joda.time.MutableDateTime
getMutableDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
org.joda.time.MutableDateTime
getMutableDateTime(long instant)
String
getName()
Api
getPluginApi(XWikiPluginInterface plugin, XWikiContext context)
org.joda.time.DateTimeZone
getServerTimezone()
org.joda.time.DateTimeZone
getTimezone(int offsetHours)
org.joda.time.DateTimeZone
getTimezone(int offsetHours, int offsetMinutes)
org.joda.time.DateTimeZone
getTimezone(String locationOrOffset)
org.joda.time.DateTimeZone
getUTCTimezone()
void
init(XWikiContext context)
-
Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin
beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endParsing, endRendering, endRenderingHandler, flushCache, flushCache, getClassName, getLocalization, insidePREHandler, localizePlainOrKey, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit
-
-
-
-
Constructor Detail
-
JodaTimePlugin
public JodaTimePlugin(String name, String className, XWikiContext context)
- Parameters:
name
- the plugin name, usually ignored, since plugins have a fixed nameclassName
- the name of this class, ignoredcontext
- the current request context
-
-
Method Detail
-
getName
public String getName()
- Specified by:
getName
in interfaceXWikiPluginInterface
- Overrides:
getName
in classXWikiDefaultPlugin
-
getPluginApi
public Api getPluginApi(XWikiPluginInterface plugin, XWikiContext context)
- Specified by:
getPluginApi
in interfaceXWikiPluginInterface
- Overrides:
getPluginApi
in classXWikiDefaultPlugin
-
init
public void init(XWikiContext context)
- Specified by:
init
in interfaceXWikiPluginInterface
- Overrides:
init
in classXWikiDefaultPlugin
-
getDateTime
public org.joda.time.DateTime getDateTime()
- See Also:
DateTime()
-
getDateTime
public org.joda.time.DateTime getDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
- See Also:
DateTime(int, int, int, int, int, int, int)
-
getDateTime
public org.joda.time.DateTime getDateTime(long instant)
- See Also:
DateTime(long)
-
getMutableDateTime
public org.joda.time.MutableDateTime getMutableDateTime()
- See Also:
MutableDateTime()
-
getMutableDateTime
public org.joda.time.MutableDateTime getMutableDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
- See Also:
MutableDateTime(int, int, int, int, int, int, int)
-
getMutableDateTime
public org.joda.time.MutableDateTime getMutableDateTime(long instant)
- See Also:
MutableDateTime(long)
-
getDateTimeFormatterForPattern
public org.joda.time.format.DateTimeFormatter getDateTimeFormatterForPattern(String pattern, XWikiContext context)
- See Also:
DateTimeFormat.forPattern(String)
-
getDateTimeFormatterForStyle
public org.joda.time.format.DateTimeFormatter getDateTimeFormatterForStyle(String style, XWikiContext context)
- See Also:
DateTimeFormat.forStyle(String)
-
getServerTimezone
public org.joda.time.DateTimeZone getServerTimezone()
- See Also:
DateTimeZone.getDefault()
-
getUTCTimezone
public org.joda.time.DateTimeZone getUTCTimezone()
- See Also:
DateTimeZone.UTC
-
getTimezone
public org.joda.time.DateTimeZone getTimezone(String locationOrOffset)
- See Also:
DateTimeZone.forID(String)
-
getTimezone
public org.joda.time.DateTimeZone getTimezone(int offsetHours)
- See Also:
DateTimeZone.forOffsetHours(int)
-
getTimezone
public org.joda.time.DateTimeZone getTimezone(int offsetHours, int offsetMinutes)
- See Also:
DateTimeZone.forOffsetHoursMinutes(int, int)
-
getDuration
public org.joda.time.Duration getDuration(long millis)
- See Also:
Duration(long)
-
getDuration
public org.joda.time.Duration getDuration(org.joda.time.ReadableInstant from, org.joda.time.ReadableInstant to)
- See Also:
Duration(ReadableInstant, ReadableInstant)
-
getISODateTimeFormatter
public org.joda.time.format.DateTimeFormatter getISODateTimeFormatter()
- Returns:
- an ISO8601 date time formatter
- Since:
- 5.2RC1
-
-