com.lowagie.text.pdf.PdfDate Maven / Gradle / Ivy
Show all versions of itext Show documentation
/*
* $Id: PdfDate.java 3117 2008-01-31 05:53:22Z xlv $
*
* Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
import java.util.Calendar;
import java.util.GregorianCalendar;
import java.util.SimpleTimeZone;
/**
* PdfDate is the PDF date object.
*
* PDF defines a standard date format. The PDF date format closely follows the format
* defined by the international standard ASN.1 (Abstract Syntax Notation One, defined
* in CCITT X.208 or ISO/IEC 8824). A date is a PdfString of the form:
*
* (D:YYYYMMDDHHmmSSOHH'mm')
*
* This object is described in the 'Portable Document Format Reference Manual version 1.3'
* section 7.2 (page 183-184)
*
* @see PdfString
* @see java.util.GregorianCalendar
*/
public class PdfDate extends PdfString {
private static final int DATE_SPACE[] = {Calendar.YEAR, 4, 0, Calendar.MONTH, 2, -1, Calendar.DAY_OF_MONTH, 2, 0,
Calendar.HOUR_OF_DAY, 2, 0, Calendar.MINUTE, 2, 0, Calendar.SECOND, 2, 0};
// constructors
/**
* Constructs a PdfDate-object.
*
* @param d the date that has to be turned into a PdfDate-object
*/
public PdfDate(Calendar d) {
super();
StringBuffer date = new StringBuffer("D:");
date.append(setLength(d.get(Calendar.YEAR), 4));
date.append(setLength(d.get(Calendar.MONTH) + 1, 2));
date.append(setLength(d.get(Calendar.DATE), 2));
date.append(setLength(d.get(Calendar.HOUR_OF_DAY), 2));
date.append(setLength(d.get(Calendar.MINUTE), 2));
date.append(setLength(d.get(Calendar.SECOND), 2));
int timezone = (d.get(Calendar.ZONE_OFFSET) + d.get(Calendar.DST_OFFSET)) / (60 * 60 * 1000);
if (timezone == 0) {
date.append('Z');
}
else if (timezone < 0) {
date.append('-');
timezone = -timezone;
}
else {
date.append('+');
}
if (timezone != 0) {
date.append(setLength(timezone, 2)).append('\'');
int zone = Math.abs((d.get(Calendar.ZONE_OFFSET) + d.get(Calendar.DST_OFFSET)) / (60 * 1000)) - (timezone * 60);
date.append(setLength(zone, 2)).append('\'');
}
value = date.toString();
}
/**
* Constructs a PdfDate-object, representing the current day and time.
*/
public PdfDate() {
this(new GregorianCalendar());
}
/**
* Adds a number of leading zeros to a given String in order to get a String
* of a certain length.
*
* @param i a given number
* @param length the length of the resulting String
* @return the resulting String
*/
private String setLength(int i, int length) { // 1.3-1.4 problem fixed by Finn Bock
StringBuffer tmp = new StringBuffer();
tmp.append(i);
while (tmp.length() < length) {
tmp.insert(0, "0");
}
tmp.setLength(length);
return tmp.toString();
}
/**
* Gives the W3C format of the PdfDate.
* @return a formatted date
*/
public String getW3CDate() {
return getW3CDate(value);
}
/**
* Gives the W3C format of the PdfDate.
* @param d the date in the format D:YYYYMMDDHHmmSSOHH'mm'
* @return a formatted date
*/
public static String getW3CDate(String d) {
if (d.startsWith("D:"))
d = d.substring(2);
StringBuffer sb = new StringBuffer();
if (d.length() < 4)
return "0000";
sb.append(d.substring(0, 4)); //year
d = d.substring(4);
if (d.length() < 2)
return sb.toString();
sb.append('-').append(d.substring(0, 2)); //month
d = d.substring(2);
if (d.length() < 2)
return sb.toString();
sb.append('-').append(d.substring(0, 2)); //day
d = d.substring(2);
if (d.length() < 2)
return sb.toString();
sb.append('T').append(d.substring(0, 2)); //hour
d = d.substring(2);
if (d.length() < 2) {
sb.append(":00Z");
return sb.toString();
}
sb.append(':').append(d.substring(0, 2)); //minute
d = d.substring(2);
if (d.length() < 2) {
sb.append('Z');
return sb.toString();
}
sb.append(':').append(d.substring(0, 2)); //second
d = d.substring(2);
if (d.startsWith("-") || d.startsWith("+")) {
String sign = d.substring(0, 1);
d = d.substring(1);
String h = "00";
String m = "00";
if (d.length() >= 2) {
h = d.substring(0, 2);
if (d.length() > 2) {
d = d.substring(3);
if (d.length() >= 2)
m = d.substring(0, 2);
}
sb.append(sign).append(h).append(':').append(m);
return sb.toString();
}
}
sb.append('Z');
return sb.toString();
}
/**
* Converts a PDF string representing a date into a Calendar.
* @param s the PDF string representing a date
* @return a Calendar representing the date or null if the string
* was not a date
*/
public static Calendar decode(String s) {
try {
if (s.startsWith("D:"))
s = s.substring(2);
GregorianCalendar calendar;
int slen = s.length();
int idx = s.indexOf('Z');
if (idx >= 0) {
slen = idx;
calendar = new GregorianCalendar(new SimpleTimeZone(0, "ZPDF"));
}
else {
int sign = 1;
idx = s.indexOf('+');
if (idx < 0) {
idx = s.indexOf('-');
if (idx >= 0)
sign = -1;
}
if (idx < 0)
calendar = new GregorianCalendar();
else {
int offset = Integer.parseInt(s.substring(idx + 1, idx + 3)) * 60;
if (idx + 5 < s.length())
offset += Integer.parseInt(s.substring(idx + 4, idx + 6));
calendar = new GregorianCalendar(new SimpleTimeZone(offset * sign * 60000, "ZPDF"));
slen = idx;
}
}
calendar.clear();
idx = 0;
for (int k = 0; k < DATE_SPACE.length; k += 3) {
if (idx >= slen)
break;
calendar.set(DATE_SPACE[k], Integer.parseInt(s.substring(idx, idx + DATE_SPACE[k + 1])) + DATE_SPACE[k + 2]);
idx += DATE_SPACE[k + 1];
}
return calendar;
}
catch (Exception e) {
return null;
}
}
}