scalafx.util.StringConverter.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2011-2015, ScalaFX Project
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the ScalaFX Project nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE SCALAFX PROJECT OR ITS CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package scalafx.util
import javafx.{util => jfxu}
import scala.language.implicitConversions
/**
* Companion Object for [[scalafx.util.StringConverter]].
*/
object StringConverter {
/**
* Converts a ScalaFX StringConverter to a JavaFX StringConverter
*
* @param s ScalaFX StringConverter
*/
implicit def sfxStringConverter2jfx[T](s: StringConverter[T]): jfxu.StringConverter[T] = new jfxu.StringConverter[T] {
def fromString(string: String): T = s.fromString(string)
def toString(t: T): String = s.toString(t)
}
/**
* Generates a StringConverter from a Pair of Conversions Functions
*
* @tparam T Type to convert
*
* @param fromStringFunction Function that converts a String to a new T instance
* @param toStringFunction Function that converts a T instance to a new String
*/
def apply[T](fromStringFunction: String => T, toStringFunction: T => String) = new StringConverter[T] {
def fromString(string: String): T = fromStringFunction(string)
def toString(t: T): String = toStringFunction(t)
}
/**
* Convenience method that will create a StringConverter implementation that just makes
* conversion from object to String. [[scalafx.util.StringConverter#fromString]] method will throw a
* `java.lang.UnsupportedOperationException`.
*
* @tparam T Type to convert
*
* @param toStringFunction Function that converts a T instance to a new String
*/
def toStringConverter[T](toStringFunction: T => String) = new StringConverter[T] {
def fromString(string: String): T =
throw new UnsupportedOperationException("Conversion from String not supported. Consider create a new StringConverter implementation that support it.")
def toString(t: T): String = toStringFunction(t)
}
/**
* Convenience method that will create a StringConverter implementation that just makes
* conversion from String to object. [[scalafx.util.StringConverter#toString]] method will throw a
* `java.lang.UnsupportedOperationException`.
*
* @tparam T Type to convert
*
* @param fromStringFunction Function that converts a String to a new T instance
*/
def fromStringConverter[T](fromStringFunction: String => T) = new StringConverter[T] {
def fromString(string: String): T = fromStringFunction(string)
def toString(t: T): String =
throw new UnsupportedOperationException("Conversion to String not supported. Consider create a new StringConverter implementation that support it.")
}
}
/**
* Wraps a JavaFX [[http://docs.oracle.com/javase/8/javafx/api/javafx/util/StringConverter.html `StringConverter`]].
*
* @constructor Creates a new ScalaFX StringConverter from a JavaFX StringConverter.
* @tparam T Type to be converted from/to `String`.
*/
abstract class StringConverter[T] {
/**
* Converts the string provided into an object defined by the specific converter.
*
* @param string `String` to be converted to a T instance.
* @return A new T instance generated from argument.
*/
def fromString(string: String): T
/**
* Converts the object provided into its string form.
*
* @param t A T instance to be its String version.
* @return String version of argument.
*/
def toString(t: T): String
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy