trait Converters extends OptionConverters with TryConverters with EitherConverters with FutureConverters
Aggregates the various traits for converting from Scala -> javascalautils.
Example on usage:
import javascalautils.converters.s2j.Converters._ val joptionSome = asJavaOption(Some("Some is never None"))
Refer to the various methods on this object for further code examples.
- Alphabetic
- By Inheritance
- Converters
- FutureConverters
- EitherConverters
- TryConverters
- OptionConverters
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJavaEither[L, R](underlying: scala.util.Either[L, R]): Either[_ <: L, _ <: R] with Serializable
Converts a scala.util.Either to a javascalautils.Either.
Converts a scala.util.Either to a javascalautils.Either.
val jEitherLeft = asJavaEither(Left("Left is not to the Right")) val jEitherRight = asJavaEither(Right("Left is not to the Right"))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- EitherConverters
- Since
1.0
-
def
asJavaFailure[T](underlying: scala.util.Failure[T]): Failure[Nothing]
Converts a scala.util.Failure to a javascalautils.Failure.
Converts a scala.util.Failure to a javascalautils.Failure.
val jfailure = asJavaFailure(Failure(new Exception("Error, terror!!!")))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- TryConverters
- Since
1.0
-
def
asJavaFuture[T](underlying: Future[T])(implicit ec: ExecutionContext): Future[T]
Converts a scala.concurrent.Future -> javascalautils.concurrent.Future.
Converts a scala.concurrent.Future -> javascalautils.concurrent.Future.
val future = Future { Thread.sleep(50) "The Future is right here!" } val jfuture = asJavaFuture(future)
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- FutureConverters
- Since
1.0
-
def
asJavaLeft[L, R](underlying: scala.util.Left[L, R]): Left[L, Nothing]
Converts a scala.util.Left to a javascalautils.Left.
Converts a scala.util.Left to a javascalautils.Left.
val jLeft = asJavaLeft(Left("Left is not to the Right"))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- EitherConverters
- Since
1.0
-
def
asJavaNone[T](underlying: scala.None.type): None[Nothing]
Converts a scala.None to a javascalautils.None.
Converts a scala.None to a javascalautils.None.
val jnone = asJavaNone(None)
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- OptionConverters
- Since
1.0
-
def
asJavaOption[T](underlying: scala.Option[T]): Option[_ <: T] with Serializable
Converts a scala.Option to a javascalautils.Option.
Converts a scala.Option to a javascalautils.Option.
val joptionSome = asJavaOption(Some("Some is never None")) val joptionNone = asJavaOption(None)
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- OptionConverters
- Since
1.0
-
def
asJavaRight[L, R](underlying: scala.util.Right[L, R]): Right[Nothing, R]
Converts a scala.util.Right to a javascalautils.Right.
Converts a scala.util.Right to a javascalautils.Right.
val jright = asJavaRight(Right("Left is not to the Right"))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- EitherConverters
- Since
1.0
-
def
asJavaSome[T](underlying: scala.Some[T]): Some[T]
Converts a scala.Some to a javascalautils.Some.
Converts a scala.Some to a javascalautils.Some.
val jsome = asJavaSome(Some("Some is never None"))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- OptionConverters
- Since
1.0
-
def
asJavaSuccess[T](underlying: scala.util.Success[T]): Success[T]
Converts a scala.util.Success to a javascalautils.Success.
Converts a scala.util.Success to a javascalautils.Success.
val jSuccess = asJavaSuccess(Success("Success is not Failure"))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- TryConverters
- Since
1.0
-
def
asJavaTry[T](underlying: scala.util.Try[T]): Try[T]
Converts a scala.util.Try to a javascalautils.Try.
Converts a scala.util.Try to a javascalautils.Try.
val jTryFailure = asJavaTry(Failure(new Exception("Error, terror!!!"))) val jTrySuccess = asJavaTry(Success("Success is not Failure"))
- underlying
The type to be converted
- returns
The converted type
- Definition Classes
- TryConverters
- Since
1.0
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): scala.Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): scala.Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): scala.Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): scala.Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): scala.Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): scala.Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
Overview
This library provides the mechanisms to convert between types provided by javascalautils to their Scala equivalence and vice-versa.
One can either perform explicit conversions by using a specific converter method or do implicit conversions using the decorator pattern provided by Scalas implicit method declaration.
Explicit Conversion
This is the mechanism for performing the conversion by invoking a specific method taking the type you want to and converting it to its Scala or Java equivalence.
There's converters for Java -> Scala, javascalautils.converters.j2s.Converters as well as from Scala -> Java, javascalautils.converters.s2j.Converters. There's also an aggregate converter containing both of these javascalautils.converters.JavaScalaUtilConverters. Either import the converters you need:
or use the aggregate object composed of both above converters
import javascalautils.converters.JavaScalaUtilConverters._
After that it's a matter of using the right converter method to do the job.
E.g.
Refer to the aggregate object javascalautils.converters.JavaScalaUtilConverters for a list of all converter methods and examples on usage.
Implicit Conversion
This utilizes the implicit mechanism in Scala to decorate any given class with new methods.
More precisely this library provides asScala methods on all supported Java types and asJava methods on all supported Scala types.
This magic is enabled by having the right imports in scope.
Just as with the explicit converters the implicit ones are divided into Java -> Scala, javascalautils.converters.j2s.Implicits as well as from Scala -> Java, javascalautils.converters.s2j.Implicits.
Or one can choose to use the aggregate implicit javascalautils.converters.JavaScalaUtilImplicits.
It's again a matter of having the right imports in scope.
or use the aggregate object composed of both above implicits.
import javascalautils.converters.JavaScalaUtilImplicits._
Now your instances should be decorated with either a asScala or asJava method.
Full Documentation
Wiki
License
Copyright 2015 Peter Nerg
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.