[deliverable/tracecompass.git] / doc / org.eclipse.tracecompass.doc.user / reference / api / org / eclipse / tracecompass / tmf / core / timestamp / TmfTimestampFormat.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Mon Jun 06 13:57:27 EDT 2016 -->
<title>TmfTimestampFormat</title>
<meta name="date" content="2016-06-06">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="TmfTimestampFormat";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.tracecompass.tmf.core.timestamp</div>
<h2 title="Class TmfTimestampFormat" class="title">Class TmfTimestampFormat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text">java.text.Format</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">java.text.DateFormat</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">java.text.SimpleDateFormat</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TmfTimestampFormat</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></pre>
<div class="block">A formatting and parsing facility that can handle timestamps that span the
 epoch with a precision down to the nanosecond. It can be understood as an
 extension of SimpleDateFormat that supports seconds since the epoch (Jan 1,
 1970, 00:00:00 GMT), additional sub-second patterns and optional delimiters.
 <p>
 The timestamp representation is broken down into a number of optional
 components that can be assembled into a fairly simple way.

 <h4>Date and Time Patterns</h4>
 All date and time pattern letters defined in <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a> are
 supported with the following exceptions:
 <blockquote>
 <table border=0 cellspacing=3 cellpadding=0 >
     <tr>
         <th align=left>Format
         <th align=left>Description
         <th align=left>Value Range
         <th align=left>Example
     <tr>
         <td><code>T</code>
         <td>The seconds since the epoch
         <td><code>0-9223372036</code>
         <td><code>1332170682</code>
     <tr>
         <td><code>Td</code>
         <td>The deciseconds since the epoch
         <td><code>0-92233720368</code>
         <td><code>13321706825</code>
     <tr>
         <td><code>Tc</code>
         <td>The centiseconds since the epoch
         <td><code>0-922337203685</code>
         <td><code>133217068253</code>
     <tr>
         <td><code>Tm</code>
         <td>The milliseconds since the epoch
         <td><code>0-9223372036854</code>
         <td><code>1332170682539</code>
     <tr>
         <td><code>Tu</code>
         <td>The microseconds since the epoch
         <td><code>0-9223372036854775</code>
         <td><code>1332170682539677</code>
     <tr>
         <td><code>Tn</code>
         <td>The nanoseconds since the epoch
         <td><code>0-9223372036854775807</code>
         <td><code>1332170682539677389</code>
     <tr>
         <td><code>S</code>
         <td>Millisecond
         <td><code>N/A</code>
         <td><code>Not supported</code>
     <tr>
         <td><code>W</code>
         <td>Week in month
         <td><code>N/A</code>
         <td><code>Not supported</code>
 </table>
 </blockquote>
 <p>
 <strong>Note:</strong> When parsing, if "T" is used, no other Date and Time
 pattern letter will be interpreted and the entire pre-delimiter input string
 will be parsed as a number. Also, "T" should be used for time intervals.
 <p>
 <strong>Note:</strong> The decimal separator between the Date and Time
 pattern and the Sub-Seconds pattern is mandatory (if there is a fractional
 part) and must be one of the sub-second delimiters. Date and Time pattern
 letters are not interpreted after the decimal separator.
 <p>
 <h4>Sub-Seconds Patterns</h4>
 <blockquote>
 <table border=0 cellspacing=3 cellpadding=0 >
     <tr>
         <th align=left>Format
         <th align=left>Description
         <th align=left>Value Range
         <th align=left>Example
     <tr>
         <td><code>S</code>
         <td>Fraction of second (or unit of second)
         <td><code>0-999999999</code>
         <td><code>123456789</code>
     <tr>
         <td><code>C</code>
         <td>Microseconds in ms
         <td><code>0-999</code>
         <td><code>456</code>
     <tr>
         <td><code>N</code>
         <td>Nanoseconds in &#181s
         <td><code>0-999</code>
         <td><code>789</code>
 </table>
 </blockquote>
 <strong>Note:</strong> The fraction of second pattern can be split, in which
 case parsing and formatting continues at the next digit. Digits beyond the
 total number of pattern letters are ignored when parsing and truncated when
 formatting.
 <p>
 <strong>Note:</strong> When parsing, "S", "C" and "N" are interchangeable
 and are all handled as fraction of second ("S"). The use of "C" and "N" is
 discouraged but is supported for backward compatibility.
 <p>

 The recognized sub-second delimiters are:
 <ul>
 <li>Space ("<code> </code>")
 <li>Period ("<code>.</code>")
 <li>Comma ("<code>,</code>")
 <li>Dash ("<code>-</code>")
 <li>Underline ("<code>_</code>")
 <li>Colon ("<code>:</code>")
 <li>Semicolon ("<code>;</code>")
 <li>Slash ("<code>/</code>")
 <li>Single-quote ("<code>''</code>")
 <li>Double-quote ("<code>"</code>")
 </ul>
 <p>
 <strong>Note:</strong> When parsing, sub-second delimiters are optional if
 unquoted. However, an extra delimiter or any other unexpected character in
 the input string ends the parsing of digits. All other quoted or unquoted
 characters in the sub-second pattern are matched against the input string.

 <h4>Examples</h4>
 The following examples show how timestamp patterns are interpreted in
 the U.S. locale. The given timestamp is 1332170682539677389L, the number
 of nanoseconds since 1970/01/01.

 <blockquote>
 <table border=0 cellspacing=3 cellpadding=0>
     <tr>
         <th align=left>Date and Time Pattern
         <th align=left>Result
     <tr>
         <td><code>"yyyy-MM-dd HH:mm:ss.SSS.SSS.SSS"</code>
         <td><code>2012-03-19 11:24:42.539.677.389</code>
     <tr>
         <td><code>"yyyy-MM-dd HH:mm:ss.SSS.SSS"</code>
         <td><code>2012-03-19 11:24:42.539.677</code>
     <tr>
         <td><code>"yyyy-D HH:mm:ss.SSS.SSS"</code>
         <td><code>2012-79 11:24:42.539.677</code>
     <tr>
         <td><code>"ss,SSSS"</code>
         <td><code>42,5397</code>
     <tr>
         <td><code>"T.SSS SSS SSS"</code>
         <td><code>1332170682.539 677 389</code>
     <tr>
         <td><code>"T"</code>
         <td><code>1332170682</code>
     <tr>
         <td><code>"Tm.SSSSSS"</code>
         <td><code>1332170682539.677389</code>
     <tr>
         <td><code>"Tn"</code>
         <td><code>1332170682539677389</code>
 </table>
 </blockquote>
 <p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Francois Chouinard</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.java.text.DateFormat">
<!--   -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">DateFormat</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.Field.html?is-external=true" title="class or interface in java.text">DateFormat.Field</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#DEFAULT_INTERVAL_PATTERN">DEFAULT_INTERVAL_PATTERN</a></span></code>
<div class="block">The default interval pattern</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#DEFAULT_TIME_PATTERN">DEFAULT_TIME_PATTERN</a></span></code>
<div class="block">The default timestamp pattern</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.text.DateFormat">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">DateFormat</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#AM_PM_FIELD" title="class or interface in java.text">AM_PM_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#DATE_FIELD" title="class or interface in java.text">DATE_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#DAY_OF_WEEK_FIELD" title="class or interface in java.text">DAY_OF_WEEK_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#DAY_OF_WEEK_IN_MONTH_FIELD" title="class or interface in java.text">DAY_OF_WEEK_IN_MONTH_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#DAY_OF_YEAR_FIELD" title="class or interface in java.text">DAY_OF_YEAR_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#DEFAULT" title="class or interface in java.text">DEFAULT</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#ERA_FIELD" title="class or interface in java.text">ERA_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#FULL" title="class or interface in java.text">FULL</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#HOUR_OF_DAY0_FIELD" title="class or interface in java.text">HOUR_OF_DAY0_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#HOUR_OF_DAY1_FIELD" title="class or interface in java.text">HOUR_OF_DAY1_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#HOUR0_FIELD" title="class or interface in java.text">HOUR0_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#HOUR1_FIELD" title="class or interface in java.text">HOUR1_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#LONG" title="class or interface in java.text">LONG</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#MEDIUM" title="class or interface in java.text">MEDIUM</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#MILLISECOND_FIELD" title="class or interface in java.text">MILLISECOND_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#MINUTE_FIELD" title="class or interface in java.text">MINUTE_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#MONTH_FIELD" title="class or interface in java.text">MONTH_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#SECOND_FIELD" title="class or interface in java.text">SECOND_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#SHORT" title="class or interface in java.text">SHORT</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#TIMEZONE_FIELD" title="class or interface in java.text">TIMEZONE_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#WEEK_OF_MONTH_FIELD" title="class or interface in java.text">WEEK_OF_MONTH_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#WEEK_OF_YEAR_FIELD" title="class or interface in java.text">WEEK_OF_YEAR_FIELD</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#YEAR_FIELD" title="class or interface in java.text">YEAR_FIELD</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat--">TmfTimestampFormat</a></span>()</code>
<div class="block">The default constructor (uses the default pattern)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat-java.lang.String-">TmfTimestampFormat</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</code>
<div class="block">The normal constructor</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat-java.lang.String-java.util.TimeZone-">TmfTimestampFormat</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
                  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone)</code>
<div class="block">The full constructor</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat-java.lang.String-java.util.TimeZone-java.util.Locale-">TmfTimestampFormat</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
                  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone,
                  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">The fuller constructor</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat-org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat-">TmfTimestampFormat</a></span>(<a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a>&nbsp;other)</code>
<div class="block">The copy constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#applyPattern-java.lang.String-">applyPattern</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#format-long-">format</a></span>(long&nbsp;value)</code>
<div class="block">Format the timestamp according to its pattern.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#getDefaulIntervalFormat--">getDefaulIntervalFormat</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#getDefaulTimeFormat--">getDefaulTimeFormat</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#parseValue-java.lang.String-">parseValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)</code>
<div class="block">Parse a string according to the format pattern</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#parseValue-java.lang.String-long-">parseValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source,
          long&nbsp;ref)</code>
<div class="block">Parse a string according to the format pattern</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#toPattern--">toPattern</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#updateDefaultFormats--">updateDefaultFormats</a></span>()</code>
<div class="block">Update the default time and default interval formats</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.text.SimpleDateFormat">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#applyLocalizedPattern-java.lang.String-" title="class or interface in java.text">applyLocalizedPattern</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#clone--" title="class or interface in java.text">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.text">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#format-java.util.Date-java.lang.StringBuffer-java.text.FieldPosition-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#formatToCharacterIterator-java.lang.Object-" title="class or interface in java.text">formatToCharacterIterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#get2DigitYearStart--" title="class or interface in java.text">get2DigitYearStart</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#getDateFormatSymbols--" title="class or interface in java.text">getDateFormatSymbols</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#hashCode--" title="class or interface in java.text">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#parse-java.lang.String-java.text.ParsePosition-" title="class or interface in java.text">parse</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#set2DigitYearStart-java.util.Date-" title="class or interface in java.text">set2DigitYearStart</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#setDateFormatSymbols-java.text.DateFormatSymbols-" title="class or interface in java.text">setDateFormatSymbols</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#toLocalizedPattern--" title="class or interface in java.text">toLocalizedPattern</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.text.DateFormat">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">DateFormat</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#format-java.util.Date-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#format-java.lang.Object-java.lang.StringBuffer-java.text.FieldPosition-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getAvailableLocales--" title="class or interface in java.text">getAvailableLocales</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getCalendar--" title="class or interface in java.text">getCalendar</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getDateInstance--" title="class or interface in java.text">getDateInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getDateInstance-int-" title="class or interface in java.text">getDateInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getDateInstance-int-java.util.Locale-" title="class or interface in java.text">getDateInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getDateTimeInstance--" title="class or interface in java.text">getDateTimeInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getDateTimeInstance-int-int-" title="class or interface in java.text">getDateTimeInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getDateTimeInstance-int-int-java.util.Locale-" title="class or interface in java.text">getDateTimeInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getInstance--" title="class or interface in java.text">getInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getNumberFormat--" title="class or interface in java.text">getNumberFormat</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getTimeInstance--" title="class or interface in java.text">getTimeInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getTimeInstance-int-" title="class or interface in java.text">getTimeInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getTimeInstance-int-java.util.Locale-" title="class or interface in java.text">getTimeInstance</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#getTimeZone--" title="class or interface in java.text">getTimeZone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#isLenient--" title="class or interface in java.text">isLenient</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#parse-java.lang.String-" title="class or interface in java.text">parse</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#parseObject-java.lang.String-java.text.ParsePosition-" title="class or interface in java.text">parseObject</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#setCalendar-java.util.Calendar-" title="class or interface in java.text">setCalendar</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#setLenient-boolean-" title="class or interface in java.text">setLenient</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#setNumberFormat-java.text.NumberFormat-" title="class or interface in java.text">setNumberFormat</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true#setTimeZone-java.util.TimeZone-" title="class or interface in java.text">setTimeZone</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.text.Format">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text">Format</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#format-java.lang.Object-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#parseObject-java.lang.String-" title="class or interface in java.text">parseObject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_TIME_PATTERN">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TIME_PATTERN</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_TIME_PATTERN</pre>
<div class="block">The default timestamp pattern</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat.DEFAULT_TIME_PATTERN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_INTERVAL_PATTERN">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_INTERVAL_PATTERN</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_INTERVAL_PATTERN</pre>
<div class="block">The default interval pattern</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat.DEFAULT_INTERVAL_PATTERN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="TmfTimestampFormat--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TmfTimestampFormat</h4>
<pre>public&nbsp;TmfTimestampFormat()</pre>
<div class="block">The default constructor (uses the default pattern)</div>
</li>
</ul>
<a name="TmfTimestampFormat-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TmfTimestampFormat</h4>
<pre>public&nbsp;TmfTimestampFormat(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</pre>
<div class="block">The normal constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the format pattern</dd>
</dl>
</li>
</ul>
<a name="TmfTimestampFormat-java.lang.String-java.util.TimeZone-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TmfTimestampFormat</h4>
<pre>public&nbsp;TmfTimestampFormat(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
                          <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone)</pre>
<div class="block">The full constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the format pattern</dd>
<dd><code>timeZone</code> - the time zone</dd>
</dl>
</li>
</ul>
<a name="TmfTimestampFormat-java.lang.String-java.util.TimeZone-java.util.Locale-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TmfTimestampFormat</h4>
<pre>public&nbsp;TmfTimestampFormat(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
                          <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone,
                          <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">The fuller constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the format pattern</dd>
<dd><code>timeZone</code> - the time zone</dd>
<dd><code>locale</code> - the locale</dd>
</dl>
</li>
</ul>
<a name="TmfTimestampFormat-org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TmfTimestampFormat</h4>
<pre>public&nbsp;TmfTimestampFormat(<a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a>&nbsp;other)</pre>
<div class="block">The copy constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the other format pattern</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="updateDefaultFormats--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateDefaultFormats</h4>
<pre>public static&nbsp;void&nbsp;updateDefaultFormats()</pre>
<div class="block">Update the default time and default interval formats</div>
</li>
</ul>
<a name="getDefaulTimeFormat--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaulTimeFormat</h4>
<pre>public static&nbsp;<a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a>&nbsp;getDefaulTimeFormat()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default time format pattern</dd>
</dl>
</li>
</ul>
<a name="getDefaulIntervalFormat--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaulIntervalFormat</h4>
<pre>public static&nbsp;<a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a>&nbsp;getDefaulIntervalFormat()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default interval format pattern</dd>
</dl>
</li>
</ul>
<a name="applyPattern-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyPattern</h4>
<pre>public&nbsp;void&nbsp;applyPattern(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#applyPattern-java.lang.String-" title="class or interface in java.text">applyPattern</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></code></dd>
</dl>
</li>
</ul>
<a name="toPattern--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPattern</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toPattern()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true#toPattern--" title="class or interface in java.text">toPattern</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></code></dd>
</dl>
</li>
</ul>
<a name="format-long-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;format(long&nbsp;value)</pre>
<div class="block">Format the timestamp according to its pattern.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the timestamp value to format (in ns)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the formatted timestamp</dd>
</dl>
</li>
</ul>
<a name="parseValue-java.lang.String-long-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseValue</h4>
<pre>public&nbsp;long&nbsp;parseValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source,
                       long&nbsp;ref)
                throws <a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></pre>
<div class="block">Parse a string according to the format pattern</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the source string</dd>
<dd><code>ref</code> - the reference (base) time (in ns)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed value (in ns)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></code> - if the string has an invalid format</dd>
</dl>
</li>
</ul>
<a name="parseValue-java.lang.String-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parseValue</h4>
<pre>public&nbsp;long&nbsp;parseValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)
                throws <a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></pre>
<div class="block">Parse a string according to the format pattern</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the source string</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed value (in ns)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></code> - if the string has an invalid format</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</body>
</html>