KickJava   Java API By Example, From Geeks To Geeks.

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


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 illuminance. The system unit for this quantity
16  * is "cd·sr/m²". By default, instances of this class are showed in Lux ("lx").
17  *
18  * @author <a HREF="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
19  * @version 6.0, June 13, 2004
20  */
21 public class Illuminance extends Quantity {
22
23     /**
24      * Holds the associated unit.
25      */
26     private final static Unit<Illuminance> UNIT = SI.LUX;
27
28     /**
29      * Holds the factory for this class.
30      */
31     private final static Factory<Illuminance> FACTORY = new Factory<Illuminance>(
32             UNIT) {
33         protected Illuminance create() {
34             return new Illuminance();
35         }
36     }.useFor(UNIT.getBaseUnits());
37
38     /**
39      * Represents a {@link Illuminance} amounting to nothing.
40      */
41     public final static Illuminance ZERO = Quantity.valueOf(0, UNIT);
42
43     /**
44      * Default constructor (allows for derivation).
45      */
46     protected Illuminance() {
47     }
48
49     /**
50      * Shows {@link Illuminance} instances in the specified unit.
51      *
52      * @param unit the display unit for {@link Illuminance} instances.
53      */
54     public static void showAs(Unit unit) {
55         QuantityFormat.show(Illuminance.class, unit);
56     }
57
58     private static final long serialVersionUID = 1L;
59
60 }
Popular Tags