/**

  * Copyright 2009 Timothy Johnston 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.timjohnstondev.unitconverter.model;

 /**

  * A {@code Conversion} provides access to the unit symbol, html formatted symbol (used to show exponents correctly),

  * unit name and the conversion factor or formula.

  */

 public interface Conversion

 {

   /**

    * Returns this {@code Conversion}'s factor or formula used to convert from one set of units to another.

    * 

    * @return this {@code Conversion}'s factor or formula to perform the conversion

    */

   String getConversion();

   /**

    * Returns this symbol's name in unabbreviated words for this {@link Conversion}.

    * 

    * @return the name for this symbol

    */

   String getUnitName();

   /**

    * Returns the raw text unit symbol for this {@link Conversion}.

    * 

    * @return the unit symbol

    */

   String getUnitSymbol();

   /**

    * Returns the html formatted unit symbol (used to show exponents correctly) for this {@link Conversion}.

    * 

    * @return the html formatted unit symbol

    */

   String getFormattedUnitSymbol();

   /**

    * Updates the unit separator symbol

    * 

    * @param symbol the new unit separator symbol

    */

   void setUnitSeparator(String symbol);

 }