FloatUnit.java

/*
 * Copyright 2005 Robert Cooper, Temple of the Screaming Penguin
 *
 * Licensed 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 com.rometools.modules.base.types;

import com.rometools.modules.base.io.GoogleBaseParser;

/**
 * This class represents a quantity consisting of a float value and an optional units specification.
 */
public class FloatUnit implements CloneableType {
    /**
     * Units
     */
    private String units;
    /**
     * Float value
     */
    private final float value;

    /**
     * Looks for a char in an array
     *
     * @param find char to search for
     * @param array array to search
     * @return boolean indicating presence.
     */
    private boolean inCharArray(final char find, final char[] array) {
        for (final char element : array) {
            if (find == element) {
                return true;
            }
        }
        return false;
    }

    /**
     * Creates a new float unit by parsing a String value
     *
     * @param source String value to parse
     */
    public FloatUnit(final String source) {
        final String parse = source.trim();
        int space = -1;
        for (int i = 0; i < parse.length(); i++) {
            if (!inCharArray(parse.charAt(i), GoogleBaseParser.FLOAT_CHARS)) {
                space = i;
                break;
            }
        }

        if (space == -1) {
            space = parse.length();
        }

        value = Float.parseFloat(GoogleBaseParser.stripNonValidCharacters(GoogleBaseParser.FLOAT_CHARS, parse.substring(0, space)));

        if (space != parse.length()) {
            units = parse.substring(space, parse.length()).trim();
        }
    }

    /**
     * @param value float value
     * @param units Units represented, or null.
     */
    public FloatUnit(final float value, final String units) {
        this.value = value;
        this.units = units;
    }

    /**
     * Returns the units.
     *
     * @return Returns the units.
     */
    public String getUnits() {
        return units;
    }

    /**
     * Returns the float value.
     *
     * @return Returns the float value.
     */
    public float getValue() {
        return value;
    }

    /**
     * Duplicates the object.
     *
     * @return Duplicate FloatUnit
     */
    @Override
    public Object clone() {
        return new FloatUnit(0 + value, units);
    }

    /**
     * Returns a String representation of the object.
     *
     * @return Returns a String representation of the object.
     */
    @Override
    public String toString() {
        if (units != null && units.trim().length() > 0) {
            return value + " " + units;
        } else {
            return Float.toString(value);
        }
    }

    @Override
    public boolean equals(final Object o) {
        if (!(o instanceof FloatUnit)) {
            return false;
        }
        final FloatUnit f = (FloatUnit) o;
        if (f.getValue() != value) {
            return false;
        }
        if (units == f.getUnits() || units != null && units.equals(f.getUnits())) {
            return true;
        }
        return false;
    }
}