View Javadoc
1 package org.apache.torque.om; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>. 55 */ 56 57 import java.util.Date; 58 59 /*** 60 * This class can be used as an ObjectKey to uniquely identify an 61 * object within an application where the id is a Date. 62 * 63 * @author <a href="mailto:jmcnally@apache.org">John McNally</a> 64 * @version $Id: DateKey.java,v 1.9 2002/11/26 22:32:55 mpoeschl Exp $ 65 */ 66 public class DateKey extends SimpleKey 67 { 68 69 /*** 70 * Creates an DateKey whose internal representation will be 71 * set later, through a set method 72 */ 73 public DateKey() 74 { 75 } 76 77 /*** 78 * Creates a DateKey whose internal representation is a Date 79 * given by the long number given by the String 80 * 81 * @param key the key value 82 * @throws NumberFormatException if key is not valid 83 */ 84 public DateKey(String key) throws NumberFormatException 85 { 86 this.key = new Date(Long.parseLong(key)); 87 } 88 89 /*** 90 * Creates a DateKey 91 * 92 * @param key the key value 93 */ 94 public DateKey(Date key) 95 { 96 this.key = key; 97 } 98 99 /*** 100 * Creates a DateKey that is equivalent to key. 101 * 102 * @param key the key value 103 */ 104 public DateKey(DateKey key) 105 { 106 if (key != null) 107 { 108 this.key = key.getValue(); 109 } 110 else 111 { 112 this.key = null; 113 } 114 } 115 116 /*** 117 * Sets the internal representation to a String 118 * 119 * @param key the key value 120 */ 121 public void setValue(String key) 122 { 123 this.key = new Date(Long.parseLong(key)); 124 } 125 126 /*** 127 * Sets the internal representation to the same object used by key. 128 * 129 * @param key the key value 130 */ 131 public void setValue(DateKey key) 132 { 133 if (key != null) 134 { 135 this.key = key.getValue(); 136 } 137 else 138 { 139 this.key = null; 140 } 141 } 142 143 /*** 144 * Access the underlying Date object. 145 * 146 * @return a <code>Date</code> value 147 */ 148 public Date getDate() 149 { 150 return (Date) key; 151 } 152 153 /*** 154 * keyObj is equal to this DateKey if keyObj is a DateKey or String 155 * that contains the same information this key contains. Two ObjectKeys 156 * that both contain null values are not considered equal. 157 * 158 * @param keyObj the comparison value 159 * @return whether the two objects are equal 160 */ 161 public boolean equals(Object keyObj) 162 { 163 boolean isEqual = false; 164 165 if (key != null) 166 { 167 if (keyObj instanceof String) 168 { 169 isEqual = toString().equals(keyObj); 170 } 171 // check against a DateKey. Two keys are equal, if their 172 // internal keys equivalent. 173 else if (keyObj instanceof DateKey) 174 { 175 Object obj = ((DateKey) keyObj).getValue(); 176 isEqual = key.equals(obj); 177 } 178 } 179 return isEqual; 180 } 181 182 /*** 183 * get a String representation 184 * 185 * @return a String representation of the Date or an empty String if the 186 * Date is null 187 */ 188 public String toString() 189 { 190 Date dt = getDate(); 191 return (dt == null ? "" : Long.toString(dt.getTime())); 192 } 193 }

This page was automatically generated by Maven