KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jscience > physics > quantities > ElectricPotential


1 /*
2  * JScience - Java(TM) Tools and Libraries for the Advancement of Sciences.
3  * Copyright (C) 2005 - JScience (http://jscience.org/)
4  * All rights reserved.
5  *
6  * Permission to use, copy, modify, and distribute this software is
7  * freely granted, provided that this notice is preserved.
8  */
9 package org.jscience.physics.quantities;
10
11 import org.jscience.physics.units.SI;
12 import org.jscience.physics.units.Unit;
13
14 /**
15  * This class represents an electric potential or electromotive force.
16  * The system unit for this quantity is "m²·kg/(s³·A)". By default, instances
17  * of this class are showed in Volt ("V").
18  *
19  * @author <a HREF="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
20  * @version 1.0, October 24, 2004
21  */
22 public class ElectricPotential extends Quantity {
23
24     /**
25      * Holds the associated unit.
26      */
27     private final static Unit<ElectricPotential> UNIT = SI.VOLT;
28
29     /**
30      * Holds the factory for this class.
31      */
32     private final static Factory<ElectricPotential> FACTORY = new Factory<ElectricPotential>(
33             UNIT) {
34         protected ElectricPotential create() {
35             return new ElectricPotential();
36         }
37     }.useFor(UNIT.getBaseUnits());
38
39     /**
40      * Represents a {@link ElectricPotential} amounting to nothing.
41      */
42     public final static ElectricPotential ZERO = Quantity.valueOf(0, UNIT);
43
44     /**
45      * Default constructor (allows for derivation).
46      */
47     protected ElectricPotential() {
48     }
49
50     /**
51      * Shows {@link ElectricPotential} instances in the specified unit.
52      *
53      * @param unit the display unit for {@link ElectricPotential} instances.
54      */
55     public static void showAs(Unit unit) {
56         QuantityFormat.show(ElectricPotential.class, unit);
57     }
58
59     private static final long serialVersionUID = 1L;
60
61 }
62
Popular Tags