Object/Class

Pic

Related Docs: class Pic | package finnpic

Permalink

object Pic extends Parsable[Pic]

Contains the factory methods for creating objects of class Pic. Follows the "smart constructor" pattern, familiar from Haskell.

Some examples of Pic creation:

>>> Pic("070377-281V")
Right(070377-281V)

>>> Pic("070377-281")
Left(Invalid PIC: '070377-281'. PIC should have 11 characters, but was 10 characters.)

>>> Pic("070377-2818")
Left(Invalid PIC: '070377-2818'. The control character ('8') is wrong: it should be 'V'.)

>>> Pic.fromStringUnsafe("070377-281V")
070377-281V

// Pic.fromStringU is just a shorter alias for Pic.fromStringUnsafe.
>>> Pic.fromStringU("070377-281V")
070377-281V

// If you give Pic.fromStringUnsafe (or Pic.fromStringU) an invalid PIC, they throw an IllegalArgumentException.

Linear Supertypes

Parsable[Pic], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Pic
Parsable
AnyRef
Any

Hide All
Show All

Visibility

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
def apply(input: String): Either[String, Pic]

Create a Pic from an input String, see fromString(input:String):Either*.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val finnishLegalAge: Int
def fromString(input: String): Either[String, Pic]

Create a Pic from an input String, returning an scala.util.Either.
Create a Pic from an input String, returning an scala.util.Either.
See also fromStringUnsafe for cases where you are sure that the input is a valid PIC (or you are willing to handle exceptions).
Examples:
```
>>> Pic("070377-281V")
Right(070377-281V)

>>> Pic("070377-281")
Left(Invalid PIC: '070377-281'. PIC should have 11 characters, but was 10 characters.)

>>> Pic("070377-2818")
Left(Invalid PIC: '070377-2818'. The control character ('8') is wrong: it should be 'V'.)
```
input
a valid Personal Identity Code as a String.
returns
Left(String) if the given String is not a valid PIC, return a scala.util.Left containing an error message. Right(Pic) if the given String is a valid PIC, return a scala.util.Right containing the Pic object.

Definition Classes
Pic → Parsable
def fromStringU(input: String): Pic

A shorter alias for fromStringUnsafe.
A shorter alias for fromStringUnsafe. See the documentation for that function.
Examples:
```
>>> Pic.fromStringU("070377-281V")
070377-281V

>>> // Pic.fromStringU("foo") would throw an IllegalArgumentException.
```
Definition Classes
Parsable
def fromStringUnsafe(input: String): Pic

Create a T from an input String, throwing an scala.IllegalArgumentException if the input is not a valid String representation of T.
Create a T from an input String, throwing an scala.IllegalArgumentException if the input is not a valid String representation of T.
See also:
- fromString for cases where you are not sure if the input is a valid T (for example, the input comes from a user), which returns an Either for you to handle.
- fromStringU for a shorter named alias of this function.
Examples:
```
>>> Pic.fromStringUnsafe("070377-281V")
070377-281V

>>> // Pic.fromStringUnsafe("foo") would throw an IllegalArgumentException.
```
input
a valid String representation of T.
returns
a T object if the input is a valid String representation of T.

Definition Classes
Parsable
Exceptions thrown
scala.IllegalArgumentException if the input is not a valid String representation of T.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Parsable[Pic]

Inherited from AnyRef

Inherited from Any

Ungrouped