Java Standard Library¶
Scala Native supports a subset of the JDK core libraries reimplemented in Scala.
Supported classes¶
The classes currently available are:
java.io¶
BufferedInputStreamBufferedOutputStreamBufferedReaderBufferedWriterByteArrayInputStreamByteArrayOutputStreamCloseableDataInputDataInputStreamDataOutputDataOutputStreamEOFExceptionFileFileDescriptorFileFilterFileInputStreamFileNotFoundExceptionFileOutputStreamFileReaderFileWriterFilenameFilterFilterInputStreamFilterOutputStreamFilterReaderFlushableIOExceptionInputStreamInputStreamReaderInterruptedIOExceptionLineNumberReaderNotSerializableExceptionObjectStreamExceptionOutputStreamOutputStreamWriterPrintStreamPrintWriterPushbackInputStreamPushbackReaderRandomAccessFileReaderSerializableStringReaderStringWriterSyncFailedExceptionUTFDataFormatExceptionUncheckedIOExceptionUnsupportedEncodingExceptionWriter
java.lang¶
AbstractMethodErrorAbstractStringBuilderAppendableArithmeticExceptionArrayIndexOutOfBoundsExceptionArrayStoreExceptionAssertionErrorAutoCloseableBooleanBootstrapMethodErrorByteByteCacheCharSequenceCharacterCharacter.SubsetCharacter.UnicodeBlockCharacterCacheClassCastExceptionClassCircularityErrorClassFormatErrorClassLoaderClassNotFoundExceptionCloneNotSupportedExceptionCloneableComparableDoubleEnumEnumConstantNotPresentExceptionErrorExceptionExceptionInInitializerErrorFloatIllegalAccessErrorIllegalAccessExceptionIllegalArgumentExceptionIllegalMonitorStateExceptionIllegalStateExceptionIllegalThreadStateExceptionIncompatibleClassChangeErrorIndexOutOfBoundsExceptionInheritableThreadLocalInstantiationErrorInstantiationExceptionIntegerIntegerCacheIntegerDecimalScaleInternalErrorInterruptedExceptionIterableLinkageErrorLongLongCacheMathMathRandNegativeArraySizeExceptionNoClassDefFoundErrorNoSuchFieldErrorNoSuchFieldExceptionNoSuchMethodErrorNoSuchMethodExceptionNullPointerExceptionNumberNumberFormatExceptionOutOfMemoryErrorProcessProcessBuilderProcessBuilder.RedirectProcessBuilder.Redirect.TypeReadableReflectiveOperationExceptionRejectedExecutionExceptionRunnableRuntimeRuntimeExceptionSecurityExceptionShortStackOverflowErrorStackTraceStackTraceElementStringStringBufferStringBuilderStringIndexOutOfBoundsExceptionSystemThreadThread.UncaughtExceptionHandlerThreadDeathThreadLocalThrowableTypeNotPresentExceptionUnknownErrorUnsatisfiedLinkErrorUnsupportedClassVersionErrorUnsupportedOperationExceptionVerifyErrorVirtualMachineErrorVoidannotation.Annotationannotation.Retentionannotation.RetentionPolicyconstant.Constableconstant.ConstantDescref.PhantomReferenceref.Referenceref.ReferenceQueueref.SoftReferenceref.WeakReferencereflect.AccessibleObjectreflect.Arrayreflect.Constructorreflect.Executablereflect.Fieldreflect.InvocationTargetExceptionreflect.Methodreflect.UndeclaredThrowableException
java.math¶
BigDecimalBigIntegerBitLevelConversionDivisionElementaryLogicalMathContextMultiplicationPrimalityRoundingMode
java.net¶
BindExceptionConnectExceptionInet4AddressInet6AddressInetAddressInetAddressBaseInetSocketAddressMalformedURLExceptionNoRouteToHostExceptionPortUnreachableExceptionServerSocketSocketSocketAddressSocketExceptionSocketImplSocketInputStreamSocketOptionSocketOptionsSocketOutputStreamSocketTimeoutExceptionURIURIEncoderDecoderURISyntaxExceptionURLURLClassLoaderURLConnectionURLDecoderURLEncoderUnknownHostExceptionUnknownServiceException
java.nio¶
BufferBufferOverflowExceptionBufferUnderflowExceptionByteBufferByteOrderCharBufferDoubleBufferFloatBufferIntBufferInvalidMarkExceptionLongBufferMappedByteBufferReadOnlyBufferExceptionShortBufferchannels.ByteChannelchannels.Channelchannels.Channelschannels.ClosedChannelExceptionchannels.FileChannelchannels.FileChannel.MapModechannels.FileLockchannels.GatheringByteChannelchannels.InterruptibleChannelchannels.NonReadableChannelExceptionchannels.NonWritableChannelExceptionchannels.OverlappingFileLockExceptionchannels.ReadableByteChannelchannels.ScatteringByteChannelchannels.SeekableByteChannelchannels.WritableByteChannelchannels.spi.AbstractInterruptibleChannelcharset.CharacterCodingExceptioncharset.Charsetcharset.CharsetDecodercharset.CharsetEncodercharset.CoderMalfunctionErrorcharset.CoderResultcharset.CodingErrorActioncharset.IllegalCharsetNameExceptioncharset.MalformedInputExceptioncharset.StandardCharsetscharset.UnmappableCharacterExceptioncharset.UnsupportedCharsetExceptionfile.AccessDeniedExceptionfile.CopyOptionfile.DirectoryIteratorExceptionfile.DirectoryNotEmptyExceptionfile.DirectoryStreamfile.DirectoryStream.Filterfile.DirectoryStreamImplfile.FileAlreadyExistsExceptionfile.FileSystemfile.FileSystemExceptionfile.FileSystemLoopExceptionfile.FileSystemNotFoundExceptionfile.FileSystemsfile.FileVisitOptionfile.FileVisitResultfile.FileVisitorfile.Filesfile.InvalidPathExceptionfile.LinkOptionfile.NoSuchFileExceptionfile.NotDirectoryExceptionfile.NotLinkExceptionfile.OpenOptionfile.Pathfile.PathMatcherfile.Pathsfile.RegexPathMatcherfile.SimpleFileVisitorfile.StandardCopyOptionfile.StandardOpenOptionfile.StandardWatchEventKindsfile.WatchEventfile.WatchEvent.Kindfile.WatchEvent.Modifierfile.WatchKeyfile.WatchServicefile.Watchablefile.attribute.AclEntryfile.attribute.AclFileAttributeViewfile.attribute.AttributeViewfile.attribute.BasicFileAttributeViewfile.attribute.BasicFileAttributesfile.attribute.DosFileAttributeViewfile.attribute.DosFileAttributesfile.attribute.FileAttributefile.attribute.FileAttributeViewfile.attribute.FileOwnerAttributeViewfile.attribute.FileStoreAttributeViewfile.attribute.FileTimefile.attribute.GroupPrincipalfile.attribute.PosixFileAttributeViewfile.attribute.PosixFileAttributesfile.attribute.PosixFilePermissionfile.attribute.PosixFilePermissionsfile.attribute.UserDefinedFileAttributeViewfile.attribute.UserPrincipalfile.attribute.UserPrincipalLookupServicefile.attribute.UserPrincipalNotFoundExceptionfile.spi.FileSystemProvider
java.rmi¶
RemoteRemoteException
java.security¶
AccessControlExceptionCodeSignerDummyMessageDigestGeneralSecurityExceptionMessageDigestMessageDigestSpiNoSuchAlgorithmExceptionPrincipalTimestampTimestampConstructorHelpercert.CertPathcert.Certificatecert.CertificateEncodingExceptioncert.CertificateExceptioncert.CertificateFactorycert.X509Certificatecert.X509Extension
java.util¶
AbstractCollectionAbstractListAbstractListViewAbstractMapAbstractMap.SimpleEntryAbstractMap.SimpleImmutableEntryAbstractQueueAbstractRandomAccessListIteratorAbstractSequentialListAbstractSetArrayDequeArrayListArraysBackedUpListIteratorBase64Base64.DecoderBase64.EncoderBitSetCalendarCollectionCollectionsComparatorConcurrentModificationExceptionDateDequeDictionaryDoubleSummaryStatisticsDuplicateFormatFlagsExceptionEmptyStackExceptionEnumSetEnumerationFormatFlagsConversionMismatchExceptionFormattableFormattableFlagsFormatterFormatter.BigDecimalLayoutFormFormatterClosedExceptionGregorianCalendarHashMapHashSetHashtableIdentityHashMapIllegalFormatCodePointExceptionIllegalFormatConversionExceptionIllegalFormatExceptionIllegalFormatFlagsExceptionIllegalFormatPrecisionExceptionIllegalFormatWidthExceptionIllformedLocaleExceptionInputMismatchExceptionInvalidPropertiesFormatExceptionIntSummaryStatisticsIteratorLinkedHashMapLinkedHashSetLinkedListListListIteratorLongSummaryStatisticsMissingFormatArgumentExceptionMissingFormatWidthExceptionMissingResourceExceptionMapNavigableMapNavigableSetNoSuchElementExceptionObjectsOptionalOptionalDoubleOptionalIntOptionalLongPrimitiveIteratorPrimitiveIterator.OfDoublePrimitiveIterator.OfIntPrimitiveIterator.OfLongPriorityQueuePropertiesQueueRandomRandomAccessRandomAccessListIteratorServiceConfigurationErrorSetSizeChangeEventSortedMapSortedSetSpliteratorSpliteratorsStringJoinerStringTokenizerTooManyListenersExceptionTreeSetUUIDUnknownFormatConversionExceptionUnknownFormatFlagsExceptionWeakHashMap
java.util.concurrent¶
CallableCancellationExceptionConcurrentHashMapConcurrentHashMap.KeySetViewConcurrentLinkedQueueConcurrentMapConcurrentSkipListSetExecutionExceptionExecutorRejectedExecutionExceptionSemaphoreThreadFactoryThreadLocalRandomTimeUnitTimeoutExceptionatomic.AtomicBooleanatomic.AtomicIntegeratomic.AtomicLongatomic.AtomicLongArrayatomic.AtomicReferenceatomic.AtomicReferenceArrayatomic.LongAdderlocks.AbstractOwnableSynchronizerlocks.AbstractQueuedSynchronizerlocks.Locklocks.ReentrantLock
java.util.function¶
BiConsumerBiFunctionBiPredicateBinaryOperatorConsumerFunctionIntUnaryOperatorPredicateSupplierUnaryOperator
java.util.jar¶
AttributesAttributes.NameInitManifestJarEntryJarFileJarInputStreamJarOutputStreamManifest
java.util.regex¶
MatchResultMatcherPatternPatternSyntaxException
java.util.stream¶
BaseStreamCollectorCollector.CharacteristicsCollectorsDoubleStreamDoubleStream.BuilderDoubleStream.DoubleMapMultiConsumerStreamStream.BuilderStreamSupport
java.util.zip¶
Adler32CRC32CheckedInputStreamCheckedOutputStreamChecksumDataFormatExceptionDeflaterDeflaterOutputStreamGZIPInputStreamGZIPOutputStreamInflaterInflaterInputStreamZipConstantsZipEntryZipExceptionZipFileZipInputStreamZipOutputStream
Note: This is an ongoing effort, some of the classes listed here might be partially implemented. Please consult javalib sources for details.
Regular expressions (java.util.regex)¶
Scala Native implements java.util.regex-compatible API using Google’s RE2 library. RE2 is not a drop-in replacement for java.util.regex but handles most common cases well.
Some notes on the implementation:
The included RE2 implements a Unicode version lower than the version used in the Scala Native Character class (>= 7.0.0). The RE2 Unicode version is in the 6.n range. For reference, Java 8 released with Unicode 6.2.0.
The RE2 implemented may not match codepoints added or changed in later Unicode versions. Similarly, there may be slight differences for Unicode codepoints with high numeric value between values used by RE2 and those used by the Character class.
This implementation of RE2 does not support:
Character classes:
Unions:
[a-d[m-p]]Intersections:
[a-z&&[^aeiou]]
Predefined character classes:
\h,\H,\v,\VPatterns:
Octal:
\0100- use decimal or hexadecimal instead.Two character Hexadecimal:
\xFF- use\x00FFinstead.All alphabetic Unicode:
\uBEEF- use hex\xBEEFinstead.Escape:
\e- use\u001Binstead.
Java character function classes:
\p{javaLowerCase}\p{javaUpperCase}\p{javaWhitespace}\p{javaMirrored}
Boundary matchers:
\G,\R,\ZPossessive quantifiers:
X?+,X*+,X++,X{n}+,X{n,}+,X{n,m}+Lookaheads:
(?=X),(?!X),(?<=X),(?<!X),(?>X)Options
CANON_EQ
COMMENTS
LITERAL
UNICODE_CASE
UNICODE_CHARACTER_CLASS
UNIX_LINES
Patterns to match a Unicode binary property, such as
\p{isAlphabetic}for a codepoint with the ‘alphabetic’ property, are not supported. Often another pattern\p{isAlpha}may be used instead,\p{isAlpha}in this case.
The reference Java 8 regex package does not support certain commonly used Perl expressions supported by this implementation of RE2. For example, for named capture groups Java uses the expression “(?<foo>)” while Perl uses the expression “(?P<foo>)”.
Scala Native java.util.regex methods accept both forms. This extension is intended to useful but is not strictly Java 8 compliant. Not all RE2 Perl expressions may be exposed in this way.
The following Matcher methods have a minimal implementation:
Matcher.hasAnchoringBounds() - always return true.
Matcher.hasTransparentBounds() - always throws UnsupportedOperationException because RE2 does not support lookaheads.
Matcher.hitEnd() - always throws UnsupportedOperationException.
Matcher.region(int, int)
Matcher.regionEnd()
Matcher.regionStart()
Matcher.requireEnd() - always throws UnsupportedOperationException.
- Matcher.useAnchoringBounds(boolean) - always throws
UnsupportedOperationException
Matcher.useTransparentBounds(boolean) - always throws UnsupportedOperationException because RE2 does not support lookaheads.
Scala Native 0.3.8 required POSIX patterns to have the form
[[:alpha:]]. Now the Java standard form\p{Alpha}is accepted and the former variant pattern is not. This improves compatibility with Java but, regrettably, may require code changes when upgrading from Scala Native 0.3.8.
Embedding Resources¶
In Scala Native, resources are implemented via embedding a resource in a resulting
binary file. Only getClass().getResourceAsInputStream() is implemented.
For that to work, you have to specify an additional NativeConfig option:
nativeConfig ~= {
_.withEmbedResources(true)
}
This will include the resource files found on the classpath in the resulting binary file. Please note that files with following extensions cannot be embedded and used as a resource:
".class", ".tasty", ".nir", ".scala", ".java", ".jar"
This is to avoid unnecesarily embedding source files. If necessary, please
consider using a different file extension for embedding. Files found in the
resources/scala-native directory will not be embedded as well. It is recommended
to add the “.c” and “.h” files there.
Reasoning for the lack of getResource() and getResources():
In Scala Native, the outputted file that can be run is a binary, unlike JVM’s
classfiles and jars. For that reason, if getResources() URI methods would be implemented,
a new URI format using a seperate FileSystem would have to be added (e.g. instead
of obtaining jar:file:path.ext you would obtain embedded:path.ext). As this still
would provide a meaningful inconsistency between JVM’s javalib API and Scala
Native’s reimplementation, this remains not implemented for now. The added
getClass().getResourceAsInputStream() however is able to be consistent between
the platforms.
Continue to ISO/IEC C Standard Library.
