Module com.aoapps.encoding

Package com.aoapps.encoding

Class UrlInJavaScriptEncoder

java.lang.Object

com.aoapps.encoding.MediaEncoder

com.aoapps.encoding.BufferedEncoder

com.aoapps.encoding.UrlInJavaScriptEncoder

All Implemented Interfaces:

ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Encoder

@ThreadSafe
public class UrlInJavaScriptEncoder
extends BufferedEncoder

Encodes a URL into a JavaScript string. It EncodingContext.encodeURL(java.lang.String) to rewrite the URL as needed and surrounds it in double quotes.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
boolean	canSkipValidation(MediaType outputType)	Checks if validation may be skipped when the characters being written to this validator is already known to be valid with the given media type.
MediaType	getValidMediaInputType()	Gets the input type.
MediaType	getValidMediaOutputType()	Gets the output type.
boolean	isValidatingMediaInputType(MediaType inputType)	Checks if this is validating the provided type, which allows one validator to be substituted in place of another.
void	writePrefixTo(Appendable out)
protected void	writeSuffix(CharSequence buffer, Appendable out)

Methods inherited from class com.aoapps.encoding.BufferedEncoder

append, append, append, isBuffered, write, write, write, write, write, writeSuffixTo

Methods inherited from class com.aoapps.encoding.MediaEncoder

getInstance, writeSuffixTo

Methods inherited from class java.lang.Object

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

Method Details

getValidMediaInputType

public MediaType getValidMediaInputType()

Description copied from interface: ValidMediaInput

Gets the input type.

isValidatingMediaInputType

public boolean isValidatingMediaInputType(MediaType inputType)

Description copied from interface: ValidMediaInput

Checks if this is validating the provided type, which allows one validator to be substituted in place of another. This is acceptable when this validator is equal to, or more strict, than the given inputType.

Please note that this validator only needs to block invalid characters for inputType. This validator does not need to let through all characters, just block the invalid. This is a one-way optimization.

This is almost the inverse operation of ValidMediaInput.isValidatingMediaInputType(com.aoapps.encoding.MediaType), with the exception of characters only invalid due to nested encodings.

Returns:

true when this validator will throw exceptions on all invalid characters from the given inputType

See Also:

• ValidMediaInput.canSkipValidation(com.aoapps.encoding.MediaType)

canSkipValidation

public boolean canSkipValidation(MediaType outputType)

Description copied from interface: ValidMediaInput

Checks if validation may be skipped when the characters being written to this validator is already known to be valid with the given media type. This may be done when every valid character for the given media type is also valid within this validator.

This is almost the inverse operation of ValidMediaInput.isValidatingMediaInputType(com.aoapps.encoding.MediaType), with the exception of characters only invalid due to nested encodings.

Returns:

true when all valid characters of the given outputType are also valid on this validator

See Also:

• ValidMediaInput.isValidatingMediaInputType(com.aoapps.encoding.MediaType)

getValidMediaOutputType

public MediaType getValidMediaOutputType()

Description copied from interface: ValidMediaOutput

Gets the output type.

writePrefixTo

public void writePrefixTo(Appendable out)
                   throws IOException

Description copied from class: MediaEncoder

This default implementation validates media types in assertion but writes nothing.

Specified by:

writePrefixTo in interface Encoder

Overrides:

writePrefixTo in class MediaEncoder

Throws:

IOException

writeSuffix

protected void writeSuffix(CharSequence buffer,
 Appendable out)
                    throws IOException

Specified by:

writeSuffix in class BufferedEncoder

Throws:

IOException