com.cathive.sass

Class SassContext

java.lang.Object

com.cathive.sass.SassContext

Direct Known Subclasses:

SassDataContext, SassFileContext

public abstract class SassContext
extends Object

An (abstract) Sass context definition.

A Sass context can be obtained either by passing a file or a SCSS string definition.

Author:

Benjamin P. Jung

See Also:

SassFileContext.create(java.nio.file.Path), SassDataContext.create(java.io.InputStream)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.cathive.sass.jna.SassLibrary.Sass_Context	$context Underlying native Sass context.
protected SassOptions	options Underlying native Sass options associated with the data or file context.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SassContext(com.cathive.sass.jna.SassLibrary.Sass_Context $context, boolean standalone) Creates a new Sass context wrapper instance.

Method Summary

Modifier and Type	Method and Description
String	compile() Performs compilation of the SCSS data that is represented by this Sass context.
void	compile(OutputStream outputStream) Performs compilation of the SCSS data that is represented by this Sass context.
protected abstract com.cathive.sass.jna.SassLibrary.Sass_Compiler	createCompiler() Creates a native Sass compiler instance.
protected void	finalize()
SassOptions	getOptions() Returns the options associated with this Sass context.
void	setOptions(SassOptions options)
protected void	throwCompilationException(int compileStatus) Throws an exception if the compilation of SCSS data or an SCSS file has failed.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

$context

protected final com.cathive.sass.jna.SassLibrary.Sass_Context $context

Underlying native Sass context.

options

protected SassOptions options

Underlying native Sass options associated with the data or file context.

Constructor Detail

SassContext

protected SassContext(@Nonnull
                      com.cathive.sass.jna.SassLibrary.Sass_Context $context,
                      boolean standalone)

Creates a new Sass context wrapper instance.

Parameters:

$context - Native underlying Sass context.

standalone - Whether this context is managed by a data or file context or not. (Unmanaged / standalone context must dispose their native components during the Object's finalize phase).

Method Detail

compile

public void compile(@WillNotClose @Nonnull
                    OutputStream outputStream)
             throws SassCompilationException,
                    IOException

Performs compilation of the SCSS data that is represented by this Sass context.

Parameters:

outputStream - Output stream to be written to.

Throws:

SassCompilationException - If compilation of the SCSS source file / data fails.

IOException - If writing to the given output stream fails.

compile

public String compile()
               throws SassCompilationException

Performs compilation of the SCSS data that is represented by this Sass context.

Returns:

The result of the compilation.

Throws:

SassCompilationException - If compilation of the SCSS source file / data fails.

createCompiler

@Nonnull
protected abstract com.cathive.sass.jna.SassLibrary.Sass_Compiler createCompiler()

Creates a native Sass compiler instance.

This instance will be used in the various compile methods that are part of the public API.

Returns:

Native Sass compiler instance.

getOptions

@Nonnull
public SassOptions getOptions()

Returns the options associated with this Sass context.

Returns:

Options associated with this Sass context.

setOptions

public void setOptions(@Nonnull
                       SassOptions options)

throwCompilationException

protected void throwCompilationException(int compileStatus)

Throws an exception if the compilation of SCSS data or an SCSS file has failed.

Parameters:

compileStatus - The numeric status code that has been reported by the SCSS compiler instance.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable