java/testing/org/apache/derbyTesting/functionTests/tests/lang/Price.java

/*

   Derby - Class org.apache.derbyTesting.functionTests.tests.lang.Price

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to you under the Apache License, Version 2.0
   (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.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 */

package org.apache.derbyTesting.functionTests.tests.lang;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.math.BigDecimal;
import java.sql.Timestamp;

/**
 * Sample UDT for tests.
 */
public class Price implements Externalizable
{
    // this changed between 10.9 and 10.10 so require the 10.9 value
    private static final long serialVersionUID = 102726277789621992L;
    
    // initial version id
    private static final int FIRST_VERSION = 0;
    private static final int TIMESTAMPED_VERSION = FIRST_VERSION + 1;

    private static final Timestamp DEFAULT_TIMESTAMP = new Timestamp( 0L );

    private static Price _savedPrice;

    public String currencyCode;
    public BigDecimal amount;
    public Timestamp timeInstant;

    // methods to be registered as functions
    public static Price makePrice( ) { return makePrice( BigDecimal.valueOf(1L) ); }
    public static Price makePrice( BigDecimal cost ) { return new Price( "USD", cost, DEFAULT_TIMESTAMP ); }
    public static Price makePrice( String currencyCode, BigDecimal amount, Timestamp timeInstant ) { return new Price( currencyCode, amount, timeInstant ); }
    public static String getCurrencyCode( Price price ) { return price.currencyCode; }
    public static BigDecimal getAmount( Price price ) { return price.amount; }
    public static Timestamp getTimeInstant( Price price ) { return price.timeInstant; }
    public static void savePrice( Price price ) { _savedPrice = price; }
    public static Price getSavedPrice() { return _savedPrice; }

    // 0-arg constructor needed by Externalizable machinery
    public Price() {}

    public Price( String currencyCode, BigDecimal amount, Timestamp timeInstant )
    {
        this.currencyCode = currencyCode;
        this.amount = amount;
        this.timeInstant = timeInstant;
    }

    public String toString()
    {
        StringBuffer buffer = new StringBuffer();

        buffer.append( "Price( " + currencyCode + ", " + amount + ", "  );
        if ( DEFAULT_TIMESTAMP.equals( timeInstant ) ) { buffer.append( "XXX" ); }
        else { buffer.append( timeInstant ); }
        buffer.append( " )" );

        return buffer.toString();
    }

    public boolean equals( Object other )
    {
        if ( other == null )  { return false; }
        if ( !(other instanceof Price) ) { return false; }

        Price that = (Price) other;

        return this.toString().equals( that.toString() );
    }

    // Externalizable implementation
    public void writeExternal(ObjectOutput out) throws IOException
    {
        // first write the version id
        out.writeInt( TIMESTAMPED_VERSION );

        // now write the state
        out.writeObject( currencyCode );
        out.writeObject( amount );
        out.writeObject( timeInstant );
    }  
    public void readExternal(ObjectInput in)throws IOException, ClassNotFoundException
    {
        // read the version id
        int oldVersion = in.readInt();
        if ( oldVersion < FIRST_VERSION ) { throw new IOException( "Corrupt data stream." ); }
        if ( oldVersion > TIMESTAMPED_VERSION ) { throw new IOException( "Can't deserialize from the future." ); }

        currencyCode = (String) in.readObject();
        amount = (BigDecimal) in.readObject();

        if ( oldVersion >= TIMESTAMPED_VERSION ) { timeInstant = (Timestamp) in.readObject(); }
        else { timeInstant = DEFAULT_TIMESTAMP; }
    }
}