33 |
34 |
|
46 | 47 | Version 1.5.1 48 | | 49 |||||||||
| 53 | PREV 54 | NEXT | 55 |56 | FRAMES 57 | NO FRAMES 58 | 65 | 68 | 69 | 70 | | 71 |||||||||
77 |
79 | Serialized Form
80 |82 | 83 |
| 86 | Package hirondelle.date4j | 87 |
|---|
| 95 | Class hirondelle.date4j.DateTime extends Object implements Serializable | 96 |
|---|
100 | serialVersionUID: -1300068157085493891L 101 | 102 |
| 107 | Serialization Methods | 108 |
|---|
113 | readObject
114 |115 | private void readObject(ObjectInputStream aInputStream) 116 | throws ClassNotFoundException, 117 | IOException118 |
-
119 |
- Always treat de-serialization as a full-blown constructor, by
120 | validating the final state of the de-serialized object.
121 |
122 |
-
123 |
124 |
- Throws: 125 |
ClassNotFoundException126 |IOException
130 |
131 | writeObject
132 |133 | private void writeObject(ObjectOutputStream aOutputStream) 134 | throws IOException135 |
-
136 |
- This is the default implementation of writeObject.
137 | Customise if necessary.
138 |
139 |
-
140 |
141 |
- Throws: 142 |
IOException
143 |
| 149 | Serialized Fields | 150 |
|---|
154 | fDateTime
155 |156 | String fDateTime157 |
-
158 |
- The text form of a date. @serial
159 |
160 |
-
161 |
164 |
165 | fYear
166 |167 | Integer fYear168 |
-
169 |
-
-
170 |
173 |
174 | fMonth
175 |176 | Integer fMonth177 |
-
178 |
-
-
179 |
182 |
183 | fDay
184 |185 | Integer fDay186 |
-
187 |
-
-
188 |
191 |
192 | fHour
193 |194 | Integer fHour195 |
-
196 |
-
-
197 |
200 |
201 | fMinute
202 |203 | Integer fMinute204 |
-
205 |
-
-
206 |
209 |
210 | fSecond
211 |212 | Integer fSecond213 |
-
214 |
-
-
215 |
218 |
219 | fNanosecond
220 |221 | Integer fNanosecond222 |
-
223 |
-
-
224 |
227 |
228 | fIsAlreadyParsed
229 |230 | boolean fIsAlreadyParsed231 |
-
232 |
- Indicates if this DateTime has been parsed into its 7 constituents. @serial
233 |
234 |
-
235 |
238 |
239 | fHashCode
240 |241 | int fHashCode242 |
-
243 |
-
-
244 |
248 |
249 | 250 | 251 | 252 | 253 | 254 |
257 |
258 |
|
270 | 271 | Version 1.5.1 272 | | 273 |||||||||
| 277 | PREV 278 | NEXT | 279 |280 | FRAMES 281 | NO FRAMES 282 | 289 | 292 | 293 | 294 | | 295 |||||||||
301 | Copyright Hirondelle Systems. Published November 19, 2013 302 | 303 | 304 | -------------------------------------------------------------------------------- /classes/hirondelle/date4j/ToStringUtil.java: -------------------------------------------------------------------------------- 1 | package hirondelle.date4j; 2 | 3 | import java.lang.reflect.InvocationTargetException; 4 | import java.lang.reflect.Method; 5 | import java.lang.reflect.Modifier; 6 | import java.util.ArrayList; 7 | import java.util.List; 8 | import java.util.StringTokenizer; 9 | import java.util.logging.Logger; 10 | import java.util.regex.Matcher; 11 | import java.util.regex.Pattern; 12 | 13 | /** 14 | Implements the toString method for some common cases. 15 | 16 |
This class is intended only for cases where toString is used in 17 | an informal manner (usually for logging and stack traces). It is especially 18 | suited for public classes which model domain objects. 19 | 20 | Here is an example of a return value of the {@link #getText} method : 21 |
22 | hirondelle.web4j.model.MyUser {
23 | LoginName: Bob
24 | LoginPassword: ****
25 | EmailAddress: bob@blah.com
26 | StarRating: 1
27 | FavoriteTheory: Quantum Chromodynamics
28 | SendCard: true
29 | Age: 42
30 | DesiredSalary: 42000
31 | BirthDate: Sat Feb 26 13:45:43 EST 2005
32 | }
33 |
34 | (Previous versions of this classes used indentation within the braces. That has
35 | been removed, since it displays poorly when nesting occurs.)
36 |
37 | Here are two more examples, using classes taken from the JDK : 38 |
39 | java.util.StringTokenizer {
40 | nextElement: This
41 | hasMoreElements: true
42 | countTokens: 3
43 | nextToken: is
44 | hasMoreTokens: true
45 | }
46 |
47 | java.util.ArrayList {
48 | size: 3
49 | toArray: [blah, blah, blah]
50 | isEmpty: false
51 | }
52 |
53 |
54 | There are two use cases for this class. The typical use case is :
55 |
56 | public String toString() {
57 | return ToStringUtil.getText(this);
58 | }
59 |
60 |
61 | However, there is a case where this typical style can
62 | fail catastrophically : when two objects reference each other, and each
63 | has toString implemented as above, then the program will loop
64 | indefinitely!
65 |
66 | As a remedy for this problem, the following variation is provided : 67 |
68 | public String toString() {
69 | return ToStringUtil.getTextAvoidCyclicRefs(this, Product.class, "getId");
70 | }
71 |
72 | Here, the usual behavior is overridden for any method
73 | which returns a Product : instead of calling Product.toString,
74 | the return value of Product.getId() is used to textually represent
75 | the object.
76 | */
77 | final class ToStringUtil {
78 |
79 | /**
80 | Return an informal textual description of an object.
81 | It is highly recommened that the caller not rely on details 82 | of the returned String. See class description for examples of return 83 | values. 84 | 85 |
WARNING: If two classes have cyclic references 86 | (that is, each has a reference to the other), then infinite looping will result 87 | if both call this method! To avoid this problem, use getText 88 | for one of the classes, and {@link #getTextAvoidCyclicRefs} for the other class. 89 | 90 |
The only items which contribute to the result are the class name, and all 91 | no-argument public methods which return a value. As well, methods 92 | defined by the Object class, and factory methods which return an 93 | Object of the native class ("getInstance" methods) do not contribute. 94 | 95 |
Items are converted to a String simply by calling their 96 | toString method, with these exceptions : 97 |
-
98 |
- {@link Util#getArrayAsString(Object)} is used for arrays 99 |
- a method whose name contain the text "password" (not case-sensitive) have 100 | their return values hard-coded to "****". 101 |
If the method name follows the pattern getXXX, then the word 'get' 104 | is removed from the presented result. 105 | 106 | @param aObject the object for which a toString result is required. 107 | */ 108 | static String getText(Object aObject) { 109 | return getTextAvoidCyclicRefs(aObject, null, null); 110 | } 111 | 112 | /** 113 | As in {@link #getText}, but, for return values which are instances of 114 | aSpecialClass, then call aMethodName instead of toString. 115 | 116 |
If aSpecialClass and aMethodName are null, then the
117 | behavior is exactly the same as calling {@link #getText}.
118 | */
119 | static String getTextAvoidCyclicRefs(Object aObject, Class aSpecialClass, String aMethodName) {
120 | StringBuilder result = new StringBuilder();
121 | addStartLine(aObject, result);
122 |
123 | Method[] methods = aObject.getClass().getDeclaredMethods();
124 | for(Method method: methods){
125 | if ( isContributingMethod(method, aObject.getClass()) ){
126 | addLineForGetXXXMethod(aObject, method, result, aSpecialClass, aMethodName);
127 | }
128 | }
129 |
130 | addEndLine(result);
131 | return result.toString();
132 | }
133 |
134 | // PRIVATE //
135 |
136 | /*
137 | Names of methods in the Object class which are ignored.
138 | */
139 | private static final String fGET_CLASS = "getClass";
140 | private static final String fCLONE = "clone";
141 | private static final String fHASH_CODE = "hashCode";
142 | private static final String fTO_STRING = "toString";
143 |
144 | private static final String fGET = "get";
145 | private static final Object[] fNO_ARGS = new Object[0];
146 | private static final Class[] fNO_PARAMS = new Class[0];
147 | /*
148 | Previous versions of this class indented the data within a block.
149 | That style breaks when one object references another. The indentation
150 | has been removed, but this variable has been retained, since others might
151 | prefer the indentation anyway.
152 | */
153 | private static final String fINDENT = "";
154 | private static final String fAVOID_CIRCULAR_REFERENCES = "[circular reference]";
155 | private static final Logger fLogger = Util.getLogger(ToStringUtil.class);
156 | private static final String NEW_LINE = System.getProperty("line.separator");
157 |
158 | private static Pattern PASSWORD_PATTERN = Pattern.compile("password", Pattern.CASE_INSENSITIVE);
159 | private static String HIDDEN_PASSWORD_VALUE = "****";
160 |
161 | //prevent construction by the caller
162 | private ToStringUtil() {
163 | //empty
164 | }
165 |
166 | private static void addStartLine(Object aObject, StringBuilder aResult){
167 | aResult.append( aObject.getClass().getName() );
168 | aResult.append(" {");
169 | aResult.append(NEW_LINE);
170 | }
171 |
172 | private static void addEndLine(StringBuilder aResult){
173 | aResult.append("}");
174 | aResult.append(NEW_LINE);
175 | }
176 |
177 | /**
178 | Return true only if aMethod is public, takes no args,
179 | returns a value whose class is not the native class, is not a method of
180 | Object.
181 | */
182 | private static boolean isContributingMethod(Method aMethod, Class aNativeClass){
183 | boolean isPublic = Modifier.isPublic( aMethod.getModifiers() );
184 | boolean hasNoArguments = aMethod.getParameterTypes().length == 0;
185 | boolean hasReturnValue = aMethod.getReturnType() != Void.TYPE;
186 | boolean returnsNativeObject = aMethod.getReturnType() == aNativeClass;
187 | boolean isMethodOfObjectClass =
188 | aMethod.getName().equals(fCLONE) ||
189 | aMethod.getName().equals(fGET_CLASS) ||
190 | aMethod.getName().equals(fHASH_CODE) ||
191 | aMethod.getName().equals(fTO_STRING)
192 | ;
193 | return
194 | isPublic &&
195 | hasNoArguments &&
196 | hasReturnValue &&
197 | ! isMethodOfObjectClass &&
198 | ! returnsNativeObject;
199 | }
200 |
201 | private static void addLineForGetXXXMethod(
202 | Object aObject,
203 | Method aMethod,
204 | StringBuilder aResult,
205 | Class aCircularRefClass,
206 | String aCircularRefMethodName
207 | ){
208 | aResult.append(fINDENT);
209 | aResult.append( getMethodNameMinusGet(aMethod) );
210 | aResult.append(": ");
211 | Object returnValue = getMethodReturnValue(aObject, aMethod);
212 | if ( returnValue != null && returnValue.getClass().isArray() ) {
213 | aResult.append( Util.getArrayAsString(returnValue) );
214 | }
215 | else {
216 | if (aCircularRefClass == null) {
217 | aResult.append( returnValue );
218 | }
219 | else {
220 | if (aCircularRefClass == returnValue.getClass()) {
221 | Method method = getMethodFromName(aCircularRefClass, aCircularRefMethodName);
222 | if ( isContributingMethod(method, aCircularRefClass)){
223 | returnValue = getMethodReturnValue(returnValue, method);
224 | aResult.append( returnValue );
225 | }
226 | else {
227 | aResult.append(fAVOID_CIRCULAR_REFERENCES);
228 | }
229 | }
230 | }
231 | }
232 | aResult.append( NEW_LINE );
233 | }
234 |
235 | private static String getMethodNameMinusGet(Method aMethod){
236 | String result = aMethod.getName();
237 | if (result.startsWith(fGET) ) {
238 | result = result.substring(fGET.length());
239 | }
240 | return result;
241 | }
242 |
243 | /** Return value is possibly-null. */
244 | private static Object getMethodReturnValue(Object aObject, Method aMethod){
245 | Object result = null;
246 | try {
247 | result = aMethod.invoke(aObject, fNO_ARGS);
248 | }
249 | catch (IllegalAccessException ex){
250 | vomit(aObject, aMethod);
251 | }
252 | catch (InvocationTargetException ex){
253 | vomit(aObject, aMethod);
254 | }
255 | result = dontShowPasswords(result, aMethod);
256 | return result;
257 | }
258 |
259 | private static Method getMethodFromName(Class aSpecialClass, String aMethodName){
260 | Method result = null;
261 | try {
262 | result = aSpecialClass.getMethod(aMethodName, fNO_PARAMS);
263 | }
264 | catch ( NoSuchMethodException ex){
265 | vomit(aSpecialClass, aMethodName);
266 | }
267 | return result;
268 | }
269 |
270 |
271 | private static void vomit(Object aObject, Method aMethod){
272 | fLogger.severe(
273 | "Cannot get return value using reflection. Class: " +
274 | aObject.getClass().getName() +
275 | " Method: " +
276 | aMethod.getName()
277 | );
278 | }
279 |
280 | private static void vomit(Class aSpecialClass, String aMethodName){
281 | fLogger.severe(
282 | "Reflection fails to get no-arg method named: " +
283 | Util.quote(aMethodName) +
284 | " for class: " +
285 | aSpecialClass.getName()
286 | );
287 | }
288 |
289 | private static Object dontShowPasswords(Object aReturnValue, Method aMethod){
290 | Object result = aReturnValue;
291 | Matcher matcher = PASSWORD_PATTERN.matcher(aMethod.getName());
292 | if ( matcher.find()) {
293 | result = HIDDEN_PASSWORD_VALUE;
294 | }
295 | return result;
296 | }
297 |
298 | /*
299 | Two informal classes with cyclic references, used for testing.
300 | */
301 | private static final class Ping {
302 | public void setPong(Pong aPong){fPong = aPong; }
303 | public Pong getPong(){ return fPong; }
304 | public Integer getId() { return new Integer(123); }
305 | public String getUserPassword(){ return "blah"; }
306 | public String toString() {
307 | return getText(this);
308 | }
309 | private Pong fPong;
310 | }
311 | private static final class Pong {
312 | public void setPing(Ping aPing){ fPing = aPing; }
313 | public Ping getPing() { return fPing; }
314 | public String toString() {
315 | return getTextAvoidCyclicRefs(this, Ping.class, "getId");
316 | //to see the infinite looping, use this instead :
317 | //return getText(this);
318 | }
319 | private Ping fPing;
320 | }
321 |
322 | /**
323 | Informal test harness.
324 | */
325 | public static void main (String... args) {
326 | List
107 | The seven parts of a DateTime object. The DAY represents the day of the month (1..31), not the weekday.
108 |
109 |
110 |
111 |
315 |
333 |
10 | package hirondelle.date4j;
11 |
12 | import java.util.Locale;
13 | import java.util.TimeZone;
14 |
15 | /** Examples of how to use date4j. */
16 | public final class Examples {
17 |
18 | /**
19 | Run the examples, and output to the console.
20 |
21 | <P>Example output when you run this class:
22 | <PRE>
23 | Current date-time in default time zone : 2011-10-24 08:05:59
24 | Current date-time in Cairo : 2011-10-24 13:06:00 (Monday)
25 | Age of someone born May 16, 1995 is : 16
26 | The 3rd Friday of this month is : 2011-10-21
27 | Number of days till Christmas : 62
28 | 90 days from today is : 2012-01-22
29 | 3 months and 5 days from today is : 2012-01-29
30 | Numbers of hours difference between Paris and Perth : 6
31 | The number of weeks since Sep 6, 2010 : 59
32 | This many seconds till midnight : 57240
33 | Output using an ISO format: 2011-10-24T08:06:00
34 | The first day of this week is : 2011-10-23
35 | The number of years the JDK date-time API has been suctorial : 15
36 | </PRE>
37 | */
38 | public static void main(String... aArgs){
39 | Examples examples = new Examples();
40 | examples.currentDateTime();
41 | examples.currentDateTimeInCairo();
42 | examples.ageIfBornOnCertainDate();
43 | examples.optionsExpiry();
44 | examples.daysTillChristmas();
45 | examples.whenIs90DaysFromToday();
46 | examples.whenIs3Months5DaysFromToday();
47 | examples.hoursDifferenceBetweenParisAndPerth();
48 | examples.weeksSinceStart();
49 | examples.timeTillMidnight();
50 | examples.imitateISOFormat();
51 | examples.firstDayOfThisWeek();
52 | examples.jdkDatesSuctorial();
53 | }
54 |
55 | // PRIVATE
56 |
57 | private static void log(Object aMsg){
58 | System.out.println(String.valueOf(aMsg));
59 | }
60 |
61 | /** What is the current date-time in the JRE's default time zone? */
62 | private void currentDateTime(){
63 | DateTime now = DateTime.now(TimeZone.getDefault());
64 | String result = now.format("YYYY-MM-DD hh:mm:ss");
65 | log("Current date-time in default time zone : " + result);
66 | }
67 |
68 | /** What is the current date-time in Cairo (include weekday)? */
69 | private void currentDateTimeInCairo(){
70 | DateTime now = DateTime.now(TimeZone.getTimeZone("Africa/Cairo"));
71 | String result = now.format("YYYY-MM-DD hh:mm:ss (WWWW)", Locale.getDefault());
72 | log("Current date-time in Cairo : " + result);
73 | }
74 |
75 | /** What's the age of someone born May 16, 1995? */
76 | private void ageIfBornOnCertainDate(){
77 | DateTime today = DateTime.today(TimeZone.getDefault());
78 | DateTime birthdate = DateTime.forDateOnly(1995, 5, 16);
79 | int age = today.getYear() - birthdate.getYear();
80 | if(today.getDayOfYear() < birthdate.getDayOfYear()){
81 | age = age - 1;
82 | }
83 | log("Age of someone born May 16, 1995 is : " + age);
84 | }
85 |
86 | /** Stock options expire on the 3rd Friday of this month. What day of the month is that? */
87 | private void optionsExpiry(){
88 | DateTime today = DateTime.today(TimeZone.getDefault());
89 | DateTime firstOfMonth = today.getStartOfMonth();
90 | int result = 0;
91 | if (firstOfMonth.getWeekDay() == 7){
92 | result = 21;
93 | }
94 | else {
95 | result = 21 - firstOfMonth.getWeekDay();
96 | }
97 | DateTime thirdFriday = DateTime.forDateOnly(firstOfMonth.getYear(), firstOfMonth.getMonth(), result);
98 | log("The 3rd Friday of this month is : " + thirdFriday.format("YYYY-MM-DD"));
99 | }
100 |
101 | /** How many days till the next December 25? */
102 | private void daysTillChristmas(){
103 | DateTime today = DateTime.today(TimeZone.getDefault());
104 | DateTime christmas = DateTime.forDateOnly(today.getYear(), 12, 25);
105 | int result = 0;
106 | if(today.isSameDayAs(christmas)){
107 | // do nothing
108 | }
109 | else if (today.lt(christmas)){
110 | result = today.numDaysFrom(christmas);
111 | }
112 | else if (today.gt(christmas)){
113 | DateTime christmasNextYear = DateTime.forDateOnly(today.getYear() + 1, 12, 25);
114 | result = today.numDaysFrom(christmasNextYear);
115 | }
116 | log("Number of days till Christmas : " + result);
117 | }
118 |
119 | /** What day is 90 days from today? */
120 | private void whenIs90DaysFromToday(){
121 | DateTime today = DateTime.today(TimeZone.getDefault());
122 | log("90 days from today is : " + today.plusDays(90).format("YYYY-MM-DD"));
123 | }
124 |
125 | /** What day is 3 months and 5 days from today? */
126 | private void whenIs3Months5DaysFromToday(){
127 | DateTime today = DateTime.today(TimeZone.getDefault());
128 | DateTime result = today.plus(0,3,5,0,0,0,0,DateTime.DayOverflow.FirstDay);
129 | log("3 months and 5 days from today is : " + result.format("YYYY-MM-DD"));
130 | }
131 |
132 | /** Current number of hours difference between Paris, France and Perth, Australia. */
133 | private void hoursDifferenceBetweenParisAndPerth(){
134 | //this assumes the time diff is a whole number of hours; other styles are possible
135 | DateTime paris = DateTime.now(TimeZone.getTimeZone("Europe/Paris"));
136 | DateTime perth = DateTime.now(TimeZone.getTimeZone("Australia/Perth"));
137 | int result = perth.getHour() - paris.getHour();
138 | if( result < 0 ) {
139 | result = result + 24;
140 | }
141 | log("Numbers of hours difference between Paris and Perth : " + result);
142 | }
143 |
144 | /** How many weeks is it since Sep 6, 2010? */
145 | private void weeksSinceStart(){
146 | DateTime today = DateTime.today(TimeZone.getDefault());
147 | DateTime startOfProject = DateTime.forDateOnly(2010, 9, 6);
148 | int result = today.getWeekIndex() - startOfProject.getWeekIndex();
149 | log("The number of weeks since Sep 6, 2010 : " + result);
150 | }
151 |
152 | /** How much time till midnight? */
153 | private void timeTillMidnight(){
154 | DateTime now = DateTime.now(TimeZone.getDefault());
155 | DateTime midnight = now.plusDays(1).getStartOfDay();
156 | long result = now.numSecondsFrom(midnight);
157 | log("This many seconds till midnight : " + result);
158 | }
159 |
160 | /** Format using ISO style. */
161 | private void imitateISOFormat(){
162 | DateTime now = DateTime.now(TimeZone.getDefault());
163 | log("Output using an ISO format: " + now.format("YYYY-MM-DDThh:mm:ss"));
164 | }
165 |
166 | private void firstDayOfThisWeek(){
167 | DateTime today = DateTime.today(TimeZone.getDefault());
168 | DateTime firstDayThisWeek = today; //start value
169 | int todaysWeekday = today.getWeekDay();
170 | int SUNDAY = 1;
171 | if(todaysWeekday > SUNDAY){
172 | int numDaysFromSunday = todaysWeekday - SUNDAY;
173 | firstDayThisWeek = today.minusDays(numDaysFromSunday);
174 | }
175 | log("The first day of this week is : " + firstDayThisWeek);
176 | }
177 |
178 | /** For how many years has the JDK date-time API been suctorial? */
179 | private void jdkDatesSuctorial(){
180 | DateTime today = DateTime.today(TimeZone.getDefault());
181 | DateTime jdkFirstPublished = DateTime.forDateOnly(1996, 1, 23);
182 | int result = today.getYear() - jdkFirstPublished.getYear();
183 | log("The number of years the JDK date-time API has been suctorial : " + result);
184 | }
185 |
186 | }
187 |
188 |
189 |
190 |
--------------------------------------------------------------------------------
/docs/javadoc/src-html/hirondelle/date4j/DateTimeParser.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
10 | package hirondelle.date4j;
11 |
12 | import java.util.regex.Matcher;
13 | import java.util.regex.Pattern;
14 |
15 | /**
16 | Convert a date-time from a string into a {@link DateTime}.
17 | The primary use case for this class is converting date-times from a database <tt>ResultSet</tt>
18 | into a {@link DateTime}. It can also convert an ISO time, having a 'T' separating the date
19 | from the time.
20 | */
21 | final class DateTimeParser {
22 |
23 | /**
24 | Thrown when the given string cannot be converted into a <tt>DateTime</tt>, since it doesn't
25 | have a format allowed by this class.
26 | An unchecked exception.
27 | */
28 | static final class UnknownDateTimeFormat extends RuntimeException {
29 | private static final long serialVersionUID = -7179421566055773208L;
30 | UnknownDateTimeFormat(String aMessage){ super(aMessage); }
31 | UnknownDateTimeFormat(String aMessage, Throwable aEx){ super(aMessage, aEx); }
32 | }
33 |
34 | DateTime parse(String aDateTime) {
35 | if(aDateTime == null){
36 | throw new NullPointerException("DateTime string is null");
37 | }
38 | String dateTime = aDateTime.trim();
39 | Parts parts = splitIntoDateAndTime(dateTime);
40 | if (parts.hasTwoParts()) {
41 | parseDate(parts.datePart);
42 | parseTime(parts.timePart);
43 | }
44 | else if (parts.hasDateOnly()){
45 | parseDate(parts.datePart);
46 | }
47 | else if (parts.hasTimeOnly()){
48 | parseTime(parts.timePart);
49 | }
50 | DateTime result = new DateTime(fYear, fMonth, fDay, fHour, fMinute, fSecond, fNanosecond);
51 | return result;
52 | }
53 |
54 | // PRIVATE
55 |
56 | /**
57 | Gross pattern for dates.
58 | Detailed validation is done by DateTime.
59 | The Group index VARIES for y-m-d according to which option is selected
60 | Year: Group 1, 4, 6
61 | Month: Group 2, 5
62 | Day: Group 3
63 | */
64 | private static final Pattern DATE = Pattern.compile("(\\d{1,4})-(\\d\\d)-(\\d\\d)|(\\d{1,4})-(\\d\\d)|(\\d{1,4})");
65 |
66 | /**
67 | Gross pattern for times.
68 | Detailed validation is done by DateTime.
69 | The Group index VARIES for h-m-s-f according to which option is selected
70 | Hour: Group 1, 5, 8, 10
71 | Minute: Group 2, 6, 9
72 | Second: Group 3, 7
73 | Microsecond: Group 4
74 | */
75 | private static final String CL = "\\:"; //colon is a special character
76 | private static final String TT = "(\\d\\d)"; //colon is a special character
77 | private static final String NUM_DIGITS_FOR_FRACTIONAL_SECONDS = "9";
78 | private static final Integer NUM_DIGITS = Integer.valueOf(NUM_DIGITS_FOR_FRACTIONAL_SECONDS);
79 | private static final Pattern TIME = Pattern.compile("" +
80 | TT+CL+TT+CL+TT+ "\\." + "(\\d{1," + NUM_DIGITS_FOR_FRACTIONAL_SECONDS + "})" + "|" +
81 | TT+CL+TT+CL+TT+ "|" +
82 | TT+CL+TT+ "|" +
83 | TT
84 | );
85 |
86 | private static final String COLON = ":";
87 | private static final int THIRD_POSITION = 2;
88 |
89 | private Integer fYear;
90 | private Integer fMonth;
91 | private Integer fDay;
92 | private Integer fHour;
93 | private Integer fMinute;
94 | private Integer fSecond;
95 | private Integer fNanosecond;
96 |
97 | private class Parts {
98 | String datePart;
99 | String timePart;
100 | boolean hasTwoParts(){
101 | return datePart != null && timePart != null;
102 | }
103 | boolean hasDateOnly(){
104 | return timePart == null;
105 | }
106 | boolean hasTimeOnly(){
107 | return datePart == null;
108 | }
109 | }
110 |
111 | /** Date and time can be separated with a single space, or with a 'T' character (case-sensitive). */
112 | private Parts splitIntoDateAndTime(String aDateTime){
113 | Parts result = new Parts();
114 | int dateTimeSeparator = getDateTimeSeparator(aDateTime);
115 | boolean hasDateTimeSeparator = 0 < dateTimeSeparator && dateTimeSeparator < aDateTime.length();
116 | if (hasDateTimeSeparator){
117 | result.datePart = aDateTime.substring(0, dateTimeSeparator);
118 | result.timePart = aDateTime.substring(dateTimeSeparator+1);
119 | }
120 | else if(hasColonInThirdPlace(aDateTime)){
121 | result.timePart = aDateTime;
122 | }
123 | else {
124 | result.datePart = aDateTime;
125 | }
126 | return result;
127 | }
128 |
129 | /** Return the index of a space character, or of a 'T' character. If not found, return -1.*/
130 | int getDateTimeSeparator(String aDateTime){
131 | String SPACE = " ";
132 | int NOT_FOUND = -1;
133 | int result = NOT_FOUND;
134 | result = aDateTime.indexOf(SPACE);
135 | if(result == NOT_FOUND){
136 | result = aDateTime.indexOf("T");
137 | }
138 | return result;
139 | }
140 |
141 | private boolean hasColonInThirdPlace(String aDateTime){
142 | boolean result = false;
143 | if(aDateTime.length() >= THIRD_POSITION){
144 | result = COLON.equals(aDateTime.substring(THIRD_POSITION,THIRD_POSITION+1));
145 | }
146 | return result;
147 | }
148 |
149 | private void parseDate(String aDate) {
150 | Matcher matcher = DATE.matcher(aDate);
151 | if (matcher.matches()){
152 | String year = getGroup(matcher, 1, 4, 6);
153 | if(year !=null ){
154 | fYear = Integer.valueOf(year);
155 | }
156 | String month = getGroup(matcher, 2, 5);
157 | if(month !=null ){
158 | fMonth = Integer.valueOf(month);
159 | }
160 | String day = getGroup(matcher, 3);
161 | if(day !=null ){
162 | fDay = Integer.valueOf(day);
163 | }
164 | }
165 | else {
166 | throw new DateTimeParser.UnknownDateTimeFormat("Unexpected format for date:" + aDate);
167 | }
168 | }
169 |
170 | private String getGroup(Matcher aMatcher, int... aGroupIds){
171 | String result = null;
172 | for(int id: aGroupIds){
173 | result = aMatcher.group(id);
174 | if(result!=null) break;
175 | }
176 | return result;
177 | }
178 |
179 | private void parseTime(String aTime) {
180 | Matcher matcher = TIME.matcher(aTime);
181 | if (matcher.matches()){
182 | String hour = getGroup(matcher, 1, 5, 8, 10);
183 | if(hour !=null ){
184 | fHour = Integer.valueOf(hour);
185 | }
186 | String minute = getGroup(matcher, 2, 6, 9);
187 | if(minute !=null ){
188 | fMinute = Integer.valueOf(minute);
189 | }
190 | String second = getGroup(matcher, 3, 7);
191 | if(second !=null ){
192 | fSecond = Integer.valueOf(second);
193 | }
194 | String decimalSeconds = getGroup(matcher, 4);
195 | if(decimalSeconds !=null ){
196 | fNanosecond = Integer.valueOf(convertToNanoseconds(decimalSeconds));
197 | }
198 | }
199 | else {
200 | throw new DateTimeParser.UnknownDateTimeFormat("Unexpected format for time:" + aTime);
201 | }
202 | }
203 |
204 | /**
205 | Convert any number of decimals (1..9) into the form it would have taken if nanos had been used,
206 | by adding any 0's to the right side.
207 | */
208 | private String convertToNanoseconds(String aDecimalSeconds){
209 | StringBuilder result = new StringBuilder(aDecimalSeconds);
210 | while( result.length( ) < NUM_DIGITS ){
211 | result.append("0");
212 | }
213 | return result.toString();
214 | }
215 | }
216 |
217 |
218 |
219 |
220 |
--------------------------------------------------------------------------------
/docs/javadoc/hirondelle/date4j/DateTime.Unit.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
32 |
80 |
81 |
82 |
83 |
33 |
51 |
52 |
34 |
35 |
47 |
36 |
46 |
37 |
45 | Overview
38 | Package
39 | Class
40 | Tree
41 | Deprecated
42 | Index
43 | Help
44 |
48 | Version 1.5.1
49 |
50 |
53 |
73 |
54 | PREV CLASS
55 | NEXT CLASS
56 |
57 | FRAMES
58 | NO FRAMES
59 |
66 |
69 |
70 |
71 |
72 |
74 |
79 |
75 | SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD
76 |
77 | DETAIL: ENUM CONSTANTS | FIELD | METHOD
78 |
84 |
85 |
86 |
87 | hirondelle.date4j
88 |
90 |
89 | Enum DateTime.Unit
91 | Object
92 |
95 | 
Enum<DateTime.Unit>
93 | hirondelle.date4j.DateTime.Unit
94 |
96 |
98 |
99 |
101 |
102 |
103 |
104 |
105 |
106 | public static enum DateTime.Unit
112 |
113 |
118 |
165 |
166 |
167 |
168 |
169 |
119 |
122 |
120 | Enum Constant Summary
121 |
123 |
128 | DAY
124 |
125 |
126 |
129 |
134 | HOUR
130 |
131 |
132 |
135 |
140 | MINUTE
136 |
137 |
138 |
141 |
146 | MONTH
142 |
143 |
144 |
147 |
152 | NANOSECONDS
148 |
149 |
150 |
153 |
158 | SECOND
154 |
155 |
156 |
159 |
164 | YEAR
160 |
161 |
162 |
170 |
192 |
193 |
171 |
174 |
172 | Method Summary
173 |
175 |
182 |
176 |
177 | static DateTime.UnitvalueOf(String name)
178 |
179 |
180 | Returns the enum constant of this type with the specified name.
183 |
191 |
184 |
185 | static DateTime.Unit[]values()
186 |
187 |
188 | Returns an array containing the constants of this enum type, in
189 | the order they're declared.
194 |
201 |
202 |
195 |
197 | Methods inherited from class Enum
196 |
198 |
200 | clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
203 |
210 |
211 |
204 |
206 | Methods inherited from class Object
205 |
207 |
209 | finalize, getClass, notify, notifyAll, wait, wait, wait
217 |
222 |
223 |
218 |
221 |
219 | Enum Constant Detail
220 |
224 | YEAR
225 |
226 | public static final DateTime.Unit YEAR
227 |
228 |
231 |
229 |
230 |
232 |
233 |
234 | MONTH
235 |
236 | public static final DateTime.Unit MONTH
237 |
238 |
241 |
239 |
240 |
242 |
243 |
244 | DAY
245 |
246 | public static final DateTime.Unit DAY
247 |
248 |
251 |
249 |
250 |
252 |
253 |
254 | HOUR
255 |
256 | public static final DateTime.Unit HOUR
257 |
258 |
261 |
259 |
260 |
262 |
263 |
264 | MINUTE
265 |
266 | public static final DateTime.Unit MINUTE
267 |
268 |
271 |
269 |
270 |
272 |
273 |
274 | SECOND
275 |
276 | public static final DateTime.Unit SECOND
277 |
278 |
281 |
279 |
280 |
282 |
283 |
284 | NANOSECONDS
285 |
286 | public static final DateTime.Unit NANOSECONDS
287 |
288 |
291 |
292 |
293 |
294 |
295 |
289 |
290 |
296 |
301 |
302 |
297 |
300 |
298 | Method Detail
299 |
303 | values
304 |
305 | public static final DateTime.Unit[] values()
306 |
307 |
321 |
311 | for(DateTime.Unit c : DateTime.Unit.values())
312 | System.out.println(c);
313 |
314 |
316 |
317 |
319 |
322 |
323 |
324 | valueOf
325 |
326 | public static DateTime.Unit valueOf(String name)
327 |
328 |
341 |
342 |
334 |
339 | name - the name of the enum constant to be returned.
335 | IllegalArgumentException - if this enum type has no constant
338 | with the specified name
343 |
344 |
345 |
346 |
347 |
348 |
349 |
397 |
398 |
399 |
400 |
350 |
368 |
369 |
351 |
352 |
364 |
353 |
363 |
354 |
362 | Overview
355 | Package
356 | Class
357 | Tree
358 | Deprecated
359 | Index
360 | Help
361 |
365 | Version 1.5.1
366 |
367 |
370 |
390 |
371 | PREV CLASS
372 | NEXT CLASS
373 |
374 | FRAMES
375 | NO FRAMES
376 |
383 |
386 |
387 |
388 |
389 |
391 |
396 |
392 | SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD
393 |
394 | DETAIL: ENUM CONSTANTS | FIELD | METHOD
395 |
401 | Copyright Hirondelle Systems. Published November 19, 2013
402 |
403 |
404 |
--------------------------------------------------------------------------------