c8b81aec8705da9f5405597aaaf0798e3aad567c
[deliverable/tracecompass.git] / doc / org.eclipse.tracecompass.doc.user / reference / api / org / eclipse / tracecompass / tmf / core / timestamp / TmfTimestampFormat.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (version 1.7.0_75) on Fri Feb 06 17:16:21 EST 2015 -->
6 <title>TmfTimestampFormat</title>
7 <meta name="date" content="2015-02-06">
8 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
9 </head>
10 <body>
11 <script type="text/javascript"><!--
12 if (location.href.indexOf('is-external=true') == -1) {
13 parent.document.title="TmfTimestampFormat";
14 }
15 //-->
16 </script>
17 <noscript>
18 <div>JavaScript is disabled on your browser.</div>
19 </noscript>
20 <!-- ======== START OF CLASS DATA ======== -->
21 <div class="header">
22 <div class="subTitle">org.eclipse.tracecompass.tmf.core.timestamp</div>
23 <h2 title="Class TmfTimestampFormat" class="title">Class TmfTimestampFormat</h2>
24 </div>
25 <div class="contentContainer">
26 <ul class="inheritance">
27 <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
28 <li>
29 <ul class="inheritance">
30 <li><a href="https://docs.oracle.com/javase/7/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text">java.text.Format</a></li>
31 <li>
32 <ul class="inheritance">
33 <li><a href="https://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">java.text.DateFormat</a></li>
34 <li>
35 <ul class="inheritance">
36 <li><a href="https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">java.text.SimpleDateFormat</a></li>
37 <li>
38 <ul class="inheritance">
39 <li>org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat</li>
40 </ul>
41 </li>
42 </ul>
43 </li>
44 </ul>
45 </li>
46 </ul>
47 </li>
48 </ul>
49 <div class="description">
50 <ul class="blockList">
51 <li class="blockList">
52 <dl>
53 <dt>All Implemented Interfaces:</dt>
54 <dd><a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
55 </dl>
56 <hr>
57 <br>
58 <pre>public class <span class="strong">TmfTimestampFormat</span>
59 extends <a href="https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></pre>
60 <div class="block">A formatting and parsing facility that can handle timestamps that span the
61 epoch with a precision down to the nanosecond. It can be understood as an
62 extension of SimpleDateFormat that supports seconds since the epoch (Jan 1,
63 1970, 00:00:00 GMT), additional sub-second patterns and optional delimiters.
64 <p>
65 The timestamp representation is broken down into a number of optional
66 components that can be assembled into a fairly simple way.
67
68 <h4>Date and Time Patterns</h4>
69 All date and time pattern letters defined in <a href="https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a> are
70 supported with the following exceptions:
71 <blockquote>
72 <table border=0 cellspacing=3 cellpadding=0 >
73 <tr bgcolor="#ccccff">
74 <th align=left>Format
75 <th align=left>Description
76 <th align=left>Value Range
77 <th align=left>Example
78 <tr bgcolor="#eeeeff">
79 <td><code>T</code>
80 <td>The seconds since the epoch
81 <td><code>0-9223372036</code>
82 <td><code>1332170682</code>
83 <tr>
84 <td><code>S</code>
85 <td>Millisecond
86 <td><code>N/A</code>
87 <td><code>Not supported</code>
88 <tr bgcolor="#eeeeff">
89 <td><code>W</code>
90 <td>Week in month
91 <td><code>N/A</code>
92 <td><code>Not supported</code>
93 </table>
94 </blockquote>
95 <p>
96 <strong>Note:</strong> When parsing, if "T" is used, no other Date and Time
97 pattern letter will be interpreted and the entire pre-delimiter input string
98 will be parsed as a number. Also, "T" should be used for time intervals.
99 <p>
100 <strong>Note:</strong> The decimal separator between the Date and Time
101 pattern and the Sub-Seconds pattern is mandatory (if there is a fractional
102 part) and must be one of the sub-second delimiters. Date and Time pattern
103 letters are not interpreted after the decimal separator.
104 <p>
105 <h4>Sub-Seconds Patterns</h4>
106 <blockquote>
107 <table border=0 cellspacing=3 cellpadding=0 >
108 <tr bgcolor="#ccccff">
109 <th align=left>Format
110 <th align=left>Description
111 <th align=left>Value Range
112 <th align=left>Example
113 <tr>
114 <td><code>S</code>
115 <td>Fraction of second
116 <td><code>0-999999999</code>
117 <td><code>123456789</code>
118 <tr bgcolor="#eeeeff">
119 <td><code>C</code>
120 <td>Microseconds in ms
121 <td><code>0-999</code>
122 <td><code>456</code>
123 <tr>
124 <td><code>N</code>
125 <td>Nanoseconds in &#181s
126 <td><code>0-999</code>
127 <td><code>789</code>
128 </table>
129 </blockquote>
130 <strong>Note:</strong> The fraction of second pattern can be split, in which
131 case parsing and formatting continues at the next digit. Digits beyond the
132 total number of pattern letters are ignored when parsing and truncated when
133 formatting.
134 <p>
135 <strong>Note:</strong> When parsing, "S", "C" and "N" are interchangeable
136 and are all handled as fraction of second ("S"). The use of "C" and "N" is
137 discouraged but is supported for backward compatibility.
138 <p>
139
140 The recognized sub-second delimiters are:
141 <ul>
142 <li>Space ("<code> </code>")
143 <li>Period ("<code>.</code>")
144 <li>Comma ("<code>,</code>")
145 <li>Dash ("<code>-</code>")
146 <li>Underline ("<code>_</code>")
147 <li>Colon ("<code>:</code>")
148 <li>Semicolon ("<code>;</code>")
149 <li>Slash ("<code>/</code>")
150 <li>Single-quote ("<code>''</code>")
151 <li>Double-quote ("<code>"</code>")
152 </ul>
153 <p>
154 <strong>Note:</strong> When parsing, sub-second delimiters are optional if
155 unquoted. However, an extra delimiter or any other unexpected character in
156 the input string ends the parsing of digits. All other quoted or unquoted
157 characters in the sub-second pattern are matched against the input string.
158
159 <h4>Examples</h4>
160 The following examples show how timestamp patterns are interpreted in
161 the U.S. locale. The given timestamp is 1332170682539677389L, the number
162 of nanoseconds since 1970/01/01.
163
164 <blockquote>
165 <table border=0 cellspacing=3 cellpadding=0>
166 <tr bgcolor="#ccccff">
167 <th align=left>Date and Time Pattern
168 <th align=left>Result
169 <tr>
170 <td><code>"yyyy-MM-dd HH:mm:ss.SSS.SSS.SSS"</code>
171 <td><code>2012-03-19 11:24:42.539.677.389</code>
172 <tr bgcolor="#eeeeff">
173 <td><code>"yyyy-MM-dd HH:mm:ss.SSS.SSS"</code>
174 <td><code>2012-03-19 11:24:42.539.677</code>
175 <tr>
176 <td><code>"yyyy-D HH:mm:ss.SSS.SSS"</code>
177 <td><code>2012-79 11:24:42.539.677</code>
178 <tr bgcolor="#eeeeff">
179 <td><code>"ss,SSSS"</code>
180 <td><code>42,5397</code>
181 <tr>
182 <td><code>"T.SSS SSS SSS"</code>
183 <td><code>1332170682.539 677 389</code>
184 <tr bgcolor="#eeeeff">
185 <td><code>"T"</code>
186 <td><code>1332170682</code>
187 </table>
188 </blockquote>
189 <p></div>
190 <dl><dt><span class="strong">Since:</span></dt>
191 <dd>2.0</dd>
192 <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../serialized-form.html#org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat">Serialized Form</a></dd></dl>
193 </li>
194 </ul>
195 </div>
196 <div class="summary">
197 <ul class="blockList">
198 <li class="blockList">
199 <!-- ======== NESTED CLASS SUMMARY ======== -->
200 <ul class="blockList">
201 <li class="blockList"><a name="nested_class_summary">
202 <!-- -->
203 </a>
204 <h3>Nested Class Summary</h3>
205 <ul class="blockList">
206 <li class="blockList"><a name="nested_classes_inherited_from_class_java.text.DateFormat">
207 <!-- -->
208 </a>
209 <h3>Nested classes/interfaces inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">DateFormat</a></h3>
210 <code><a href="https://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.Field.html?is-external=true" title="class or interface in java.text">DateFormat.Field</a></code></li>
211 </ul>
212 </li>
213 </ul>
214 <!-- =========== FIELD SUMMARY =========== -->
215 <ul class="blockList">
216 <li class="blockList"><a name="field_summary">
217 <!-- -->
218 </a>
219 <h3>Field Summary</h3>
220 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
221 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
222 <tr>
223 <th class="colFirst" scope="col">Modifier and Type</th>
224 <th class="colLast" scope="col">Field and Description</th>
225 </tr>
226 <tr class="altColor">
227 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
228 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#DEFAULT_INTERVAL_PATTERN">DEFAULT_INTERVAL_PATTERN</a></strong></code>
229 <div class="block">The default interval pattern</div>
230 </td>
231 </tr>
232 <tr class="rowColor">
233 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
234 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#DEFAULT_TIME_PATTERN">DEFAULT_TIME_PATTERN</a></strong></code>
235 <div class="block">The default timestamp pattern</div>
236 </td>
237 </tr>
238 </table>
239 <ul class="blockList">
240 <li class="blockList"><a name="fields_inherited_from_class_java.text.DateFormat">
241 <!-- -->
242 </a>
243 <h3>Fields inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">DateFormat</a></h3>
244 <code><a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#YEAR_FIELD" title="class or interface in java.text">YEAR_FIELD</a></code></li>
245 </ul>
246 </li>
247 </ul>
248 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
249 <ul class="blockList">
250 <li class="blockList"><a name="constructor_summary">
251 <!-- -->
252 </a>
253 <h3>Constructor Summary</h3>
254 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
255 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
256 <tr>
257 <th class="colOne" scope="col">Constructor and Description</th>
258 </tr>
259 <tr class="altColor">
260 <td class="colOne"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat()">TmfTimestampFormat</a></strong>()</code>
261 <div class="block">The default constructor (uses the default pattern)</div>
262 </td>
263 </tr>
264 <tr class="rowColor">
265 <td class="colOne"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat(java.lang.String)">TmfTimestampFormat</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</code>
266 <div class="block">The normal constructor</div>
267 </td>
268 </tr>
269 <tr class="altColor">
270 <td class="colOne"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat(java.lang.String,%20java.util.TimeZone)">TmfTimestampFormat</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
271 <a href="https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone)</code>
272 <div class="block">The full constructor</div>
273 </td>
274 </tr>
275 <tr class="rowColor">
276 <td class="colOne"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat(java.lang.String,%20java.util.TimeZone,%20java.util.Locale)">TmfTimestampFormat</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
277 <a href="https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone,
278 <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
279 <div class="block">The fuller constructor</div>
280 </td>
281 </tr>
282 <tr class="altColor">
283 <td class="colOne"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#TmfTimestampFormat(org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat)">TmfTimestampFormat</a></strong>(<a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html" title="class in org.eclipse.tracecompass.tmf.core.timestamp">TmfTimestampFormat</a>&nbsp;other)</code>
284 <div class="block">The copy constructor</div>
285 </td>
286 </tr>
287 </table>
288 </li>
289 </ul>
290 <!-- ========== METHOD SUMMARY =========== -->
291 <ul class="blockList">
292 <li class="blockList"><a name="method_summary">
293 <!-- -->
294 </a>
295 <h3>Method Summary</h3>
296 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
297 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
298 <tr>
299 <th class="colFirst" scope="col">Modifier and Type</th>
300 <th class="colLast" scope="col">Method and Description</th>
301 </tr>
302 <tr class="altColor">
303 <td class="colFirst"><code>void</code></td>
304 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#applyPattern(java.lang.String)">applyPattern</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</code>&nbsp;</td>
305 </tr>
306 <tr class="rowColor">
307 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
308 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#format(long)">format</a></strong>(long&nbsp;value)</code>
309 <div class="block">Format the timestamp according to its pattern.</div>
310 </td>
311 </tr>
312 <tr class="altColor">
313 <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>
314 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#getDefaulIntervalFormat()">getDefaulIntervalFormat</a></strong>()</code>&nbsp;</td>
315 </tr>
316 <tr class="rowColor">
317 <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>
318 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#getDefaulTimeFormat()">getDefaulTimeFormat</a></strong>()</code>&nbsp;</td>
319 </tr>
320 <tr class="altColor">
321 <td class="colFirst"><code>long</code></td>
322 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#parseValue(java.lang.String)">parseValue</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)</code>
323 <div class="block">Parse a string according to the format pattern</div>
324 </td>
325 </tr>
326 <tr class="rowColor">
327 <td class="colFirst"><code>long</code></td>
328 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#parseValue(java.lang.String,%20long)">parseValue</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source,
329 long&nbsp;ref)</code>
330 <div class="block">Parse a string according to the format pattern</div>
331 </td>
332 </tr>
333 <tr class="altColor">
334 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
335 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#toPattern()">toPattern</a></strong>()</code>&nbsp;</td>
336 </tr>
337 <tr class="rowColor">
338 <td class="colFirst"><code>static void</code></td>
339 <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html#updateDefaultFormats()">updateDefaultFormats</a></strong>()</code>&nbsp;</td>
340 </tr>
341 </table>
342 <ul class="blockList">
343 <li class="blockList"><a name="methods_inherited_from_class_java.text.SimpleDateFormat">
344 <!-- -->
345 </a>
346 <h3>Methods inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></h3>
347 <code><a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/docs/api/java/text/SimpleDateFormat.html?is-external=true#format(java.util.Date,%20java.lang.StringBuffer,%20java.text.FieldPosition)" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/docs/api/java/text/SimpleDateFormat.html?is-external=true#parse(java.lang.String,%20java.text.ParsePosition)" title="class or interface in java.text">parse</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/text/SimpleDateFormat.html?is-external=true#toLocalizedPattern()" title="class or interface in java.text">toLocalizedPattern</a></code></li>
348 </ul>
349 <ul class="blockList">
350 <li class="blockList"><a name="methods_inherited_from_class_java.text.DateFormat">
351 <!-- -->
352 </a>
353 <h3>Methods inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text">DateFormat</a></h3>
354 <code><a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#format(java.lang.Object,%20java.lang.StringBuffer,%20java.text.FieldPosition)" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#getDateInstance(int,%20java.util.Locale)" title="class or interface in java.text">getDateInstance</a>, <a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#getDateTimeInstance(int,%20int)" title="class or interface in java.text">getDateTimeInstance</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html?is-external=true#getDateTimeInstance(int,%20int,%20java.util.Locale)" title="class or interface in java.text">getDateTimeInstance</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#getTimeInstance(int,%20java.util.Locale)" title="class or interface in java.text">getTimeInstance</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#parseObject(java.lang.String,%20java.text.ParsePosition)" title="class or interface in java.text">parseObject</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/docs/api/java/text/DateFormat.html?is-external=true#setTimeZone(java.util.TimeZone)" title="class or interface in java.text">setTimeZone</a></code></li>
355 </ul>
356 <ul class="blockList">
357 <li class="blockList"><a name="methods_inherited_from_class_java.text.Format">
358 <!-- -->
359 </a>
360 <h3>Methods inherited from class&nbsp;java.text.<a href="https://docs.oracle.com/javase/7/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text">Format</a></h3>
361 <code><a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/text/Format.html?is-external=true#parseObject(java.lang.String)" title="class or interface in java.text">parseObject</a></code></li>
362 </ul>
363 <ul class="blockList">
364 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
365 <!-- -->
366 </a>
367 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
368 <code><a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
369 </ul>
370 </li>
371 </ul>
372 </li>
373 </ul>
374 </div>
375 <div class="details">
376 <ul class="blockList">
377 <li class="blockList">
378 <!-- ============ FIELD DETAIL =========== -->
379 <ul class="blockList">
380 <li class="blockList"><a name="field_detail">
381 <!-- -->
382 </a>
383 <h3>Field Detail</h3>
384 <a name="DEFAULT_INTERVAL_PATTERN">
385 <!-- -->
386 </a>
387 <ul class="blockList">
388 <li class="blockList">
389 <h4>DEFAULT_INTERVAL_PATTERN</h4>
390 <pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_INTERVAL_PATTERN</pre>
391 <div class="block">The default interval pattern</div>
392 <dl><dt><span class="strong">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>
393 </li>
394 </ul>
395 <a name="DEFAULT_TIME_PATTERN">
396 <!-- -->
397 </a>
398 <ul class="blockListLast">
399 <li class="blockList">
400 <h4>DEFAULT_TIME_PATTERN</h4>
401 <pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_TIME_PATTERN</pre>
402 <div class="block">The default timestamp pattern</div>
403 <dl><dt><span class="strong">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>
404 </li>
405 </ul>
406 </li>
407 </ul>
408 <!-- ========= CONSTRUCTOR DETAIL ======== -->
409 <ul class="blockList">
410 <li class="blockList"><a name="constructor_detail">
411 <!-- -->
412 </a>
413 <h3>Constructor Detail</h3>
414 <a name="TmfTimestampFormat()">
415 <!-- -->
416 </a>
417 <ul class="blockList">
418 <li class="blockList">
419 <h4>TmfTimestampFormat</h4>
420 <pre>public&nbsp;TmfTimestampFormat()</pre>
421 <div class="block">The default constructor (uses the default pattern)</div>
422 </li>
423 </ul>
424 <a name="TmfTimestampFormat(java.lang.String)">
425 <!-- -->
426 </a>
427 <ul class="blockList">
428 <li class="blockList">
429 <h4>TmfTimestampFormat</h4>
430 <pre>public&nbsp;TmfTimestampFormat(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</pre>
431 <div class="block">The normal constructor</div>
432 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pattern</code> - the format pattern</dd></dl>
433 </li>
434 </ul>
435 <a name="TmfTimestampFormat(java.lang.String, java.util.TimeZone)">
436 <!-- -->
437 </a>
438 <ul class="blockList">
439 <li class="blockList">
440 <h4>TmfTimestampFormat</h4>
441 <pre>public&nbsp;TmfTimestampFormat(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
442 <a href="https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone)</pre>
443 <div class="block">The full constructor</div>
444 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pattern</code> - the format pattern</dd><dd><code>timeZone</code> - the time zone</dd><dt><span class="strong">Since:</span></dt>
445 <dd>2.1</dd></dl>
446 </li>
447 </ul>
448 <a name="TmfTimestampFormat(java.lang.String, java.util.TimeZone, java.util.Locale)">
449 <!-- -->
450 </a>
451 <ul class="blockList">
452 <li class="blockList">
453 <h4>TmfTimestampFormat</h4>
454 <pre>public&nbsp;TmfTimestampFormat(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern,
455 <a href="https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;timeZone,
456 <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
457 <div class="block">The fuller constructor</div>
458 <dl><dt><span class="strong">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><dt><span class="strong">Since:</span></dt>
459 <dd>3.2</dd></dl>
460 </li>
461 </ul>
462 <a name="TmfTimestampFormat(org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat)">
463 <!-- -->
464 </a>
465 <ul class="blockListLast">
466 <li class="blockList">
467 <h4>TmfTimestampFormat</h4>
468 <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>
469 <div class="block">The copy constructor</div>
470 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - the other format pattern</dd></dl>
471 </li>
472 </ul>
473 </li>
474 </ul>
475 <!-- ============ METHOD DETAIL ========== -->
476 <ul class="blockList">
477 <li class="blockList"><a name="method_detail">
478 <!-- -->
479 </a>
480 <h3>Method Detail</h3>
481 <a name="applyPattern(java.lang.String)">
482 <!-- -->
483 </a>
484 <ul class="blockList">
485 <li class="blockList">
486 <h4>applyPattern</h4>
487 <pre>public&nbsp;void&nbsp;applyPattern(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pattern)</pre>
488 <dl>
489 <dt><strong>Overrides:</strong></dt>
490 <dd><code><a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></code></dd>
491 </dl>
492 </li>
493 </ul>
494 <a name="format(long)">
495 <!-- -->
496 </a>
497 <ul class="blockList">
498 <li class="blockList">
499 <h4>format</h4>
500 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;format(long&nbsp;value)</pre>
501 <div class="block">Format the timestamp according to its pattern.</div>
502 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the timestamp value to format (in ns)</dd>
503 <dt><span class="strong">Returns:</span></dt><dd>the formatted timestamp</dd></dl>
504 </li>
505 </ul>
506 <a name="getDefaulIntervalFormat()">
507 <!-- -->
508 </a>
509 <ul class="blockList">
510 <li class="blockList">
511 <h4>getDefaulIntervalFormat</h4>
512 <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>
513 <dl><dt><span class="strong">Returns:</span></dt><dd>the default interval format pattern</dd></dl>
514 </li>
515 </ul>
516 <a name="getDefaulTimeFormat()">
517 <!-- -->
518 </a>
519 <ul class="blockList">
520 <li class="blockList">
521 <h4>getDefaulTimeFormat</h4>
522 <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>
523 <dl><dt><span class="strong">Returns:</span></dt><dd>the default time format pattern</dd></dl>
524 </li>
525 </ul>
526 <a name="parseValue(java.lang.String)">
527 <!-- -->
528 </a>
529 <ul class="blockList">
530 <li class="blockList">
531 <h4>parseValue</h4>
532 <pre>public&nbsp;long&nbsp;parseValue(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)
533 throws <a href="https://docs.oracle.com/javase/7/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></pre>
534 <div class="block">Parse a string according to the format pattern</div>
535 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the source string</dd>
536 <dt><span class="strong">Returns:</span></dt><dd>the parsed value (in ns)</dd>
537 <dt><span class="strong">Throws:</span></dt>
538 <dd><code><a href="https://docs.oracle.com/javase/7/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>
539 </li>
540 </ul>
541 <a name="parseValue(java.lang.String, long)">
542 <!-- -->
543 </a>
544 <ul class="blockList">
545 <li class="blockList">
546 <h4>parseValue</h4>
547 <pre>public&nbsp;long&nbsp;parseValue(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source,
548 long&nbsp;ref)
549 throws <a href="https://docs.oracle.com/javase/7/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></pre>
550 <div class="block">Parse a string according to the format pattern</div>
551 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the source string</dd><dd><code>ref</code> - the reference (base) time (in ns)</dd>
552 <dt><span class="strong">Returns:</span></dt><dd>the parsed value (in ns)</dd>
553 <dt><span class="strong">Throws:</span></dt>
554 <dd><code><a href="https://docs.oracle.com/javase/7/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>
555 </li>
556 </ul>
557 <a name="toPattern()">
558 <!-- -->
559 </a>
560 <ul class="blockList">
561 <li class="blockList">
562 <h4>toPattern</h4>
563 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toPattern()</pre>
564 <dl>
565 <dt><strong>Overrides:</strong></dt>
566 <dd><code><a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></code></dd>
567 </dl>
568 </li>
569 </ul>
570 <a name="updateDefaultFormats()">
571 <!-- -->
572 </a>
573 <ul class="blockListLast">
574 <li class="blockList">
575 <h4>updateDefaultFormats</h4>
576 <pre>public static&nbsp;void&nbsp;updateDefaultFormats()</pre>
577 <dl><dt><span class="strong">Since:</span></dt>
578 <dd>2.1</dd></dl>
579 </li>
580 </ul>
581 </li>
582 </ul>
583 </li>
584 </ul>
585 </div>
586 </div>
587 <!-- ========= END OF CLASS DATA ========= -->
588 </body>
589 </html>
This page took 0.044745 seconds and 4 git commands to generate.