com.sass_lang.embedded_protocol

Class OutboundMessage.CanonicalizeRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

com.sass_lang.embedded_protocol.OutboundMessage.CanonicalizeRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutboundMessage.CanonicalizeRequestOrBuilder, Cloneable

Enclosing class:

OutboundMessage.CanonicalizeRequest

public static final class OutboundMessage.CanonicalizeRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>
implements OutboundMessage.CanonicalizeRequestOrBuilder

 A request for a custom importer to convert an imported URL to its canonical
 format.

 If the URL is not recognized by this importer, or if no stylesheet is found
 at that URL, `CanonicalizeResponse.result` must be `null`. Otherwise, the
 importer must return an absolute URL, including a scheme.

 > The host's documentation should encourage the use of file importers (via
 > `CompileRequest.Importer.file_importer_id`, `FileImportRequest`, and
 > `FileImportResponse`) for any importers that simply refer to files on
 > disk. This will allow Sass to handle the logic of resolving partials,
 > file extensions, and index files.

 If Sass has already loaded a stylesheet with the returned canonical URL, it
 re-uses the existing parse tree. This means that importers must ensure that
 the same canonical URL always refers to the same stylesheet, *even across
 different importers*. Importers must also ensure that any canonicalized
 URLs they return can be passed back to `CanonicalizeRequest` and will be
 returned unchanged.

 If this importer's URL format supports file extensions, it should
 canonicalize them the same way as the default filesystem importer:

 * The importer should look for stylesheets by adding the prefix `_` to the
 URL's basename, and by adding the extensions `.sass` and `.scss` if the
 URL doesn't already have one of those extensions. For example, if the URL
 was `foo/bar/baz`, the importer would look for:

 * `foo/bar/baz.sass`
 * `foo/bar/baz.scss`
 * `foo/bar/_baz.sass`
 * `foo/bar/_baz.scss`

 If the URL was foo/bar/baz.scss, the importer would just look for:

 * `foo/bar/baz.scss`
 * `foo/bar/_baz.scss`

 If the importer finds a stylesheet at more than one of these URLs, it
 should respond with a `CanonicalizeResponse.result.error` indicating that
 the import is ambiguous. Note that if the extension is explicitly
 specified, a stylesheet with another extension may exist without error.

 * If none of the possible paths is valid, the importer should perform the
 same resolution on the URL followed by `/index`. In the example above, it
 would look for:

 * `foo/bar/baz/_index.sass`
 * `foo/bar/baz/index.sass`
 * `foo/bar/baz/_index.scss`
 * `foo/bar/baz/index.scss`

 As above, if the importer finds a stylesheet at more than one of these
 URLs, it should respond with a `CanonicalizeResponse.result.error`
 indicating that the import is ambiguous.
 

Protobuf type sass.embedded_protocol.OutboundMessage.CanonicalizeRequest

Method Summary

Modifier and Type	Method and Description
OutboundMessage.CanonicalizeRequest	build()
OutboundMessage.CanonicalizeRequest	buildPartial()
OutboundMessage.CanonicalizeRequest.Builder	clear()
OutboundMessage.CanonicalizeRequest.Builder	clearContainingUrl() The canonical URL of the [current source file] that contained the load to be canonicalized.
OutboundMessage.CanonicalizeRequest.Builder	clearFromImport() Whether this request comes from an `@import` rule.
OutboundMessage.CanonicalizeRequest.Builder	clearId() uint32 id = 1;
OutboundMessage.CanonicalizeRequest.Builder	clearImporterId() The unique ID of the importer being invoked.
OutboundMessage.CanonicalizeRequest.Builder	clearUrl() The URL of the import to be canonicalized.
String	getContainingUrl() The canonical URL of the [current source file] that contained the load to be canonicalized.
com.google.protobuf.ByteString	getContainingUrlBytes() The canonical URL of the [current source file] that contained the load to be canonicalized.
OutboundMessage.CanonicalizeRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getFromImport() Whether this request comes from an `@import` rule.
int	getId() uint32 id = 1;
int	getImporterId() The unique ID of the importer being invoked.
String	getUrl() The URL of the import to be canonicalized.
com.google.protobuf.ByteString	getUrlBytes() The URL of the import to be canonicalized.
boolean	hasContainingUrl() The canonical URL of the [current source file] that contained the load to be canonicalized.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
OutboundMessage.CanonicalizeRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
OutboundMessage.CanonicalizeRequest.Builder	mergeFrom(com.google.protobuf.Message other)
OutboundMessage.CanonicalizeRequest.Builder	mergeFrom(OutboundMessage.CanonicalizeRequest other)
OutboundMessage.CanonicalizeRequest.Builder	setContainingUrl(String value) The canonical URL of the [current source file] that contained the load to be canonicalized.
OutboundMessage.CanonicalizeRequest.Builder	setContainingUrlBytes(com.google.protobuf.ByteString value) The canonical URL of the [current source file] that contained the load to be canonicalized.
OutboundMessage.CanonicalizeRequest.Builder	setFromImport(boolean value) Whether this request comes from an `@import` rule.
OutboundMessage.CanonicalizeRequest.Builder	setId(int value) uint32 id = 1;
OutboundMessage.CanonicalizeRequest.Builder	setImporterId(int value) The unique ID of the importer being invoked.
OutboundMessage.CanonicalizeRequest.Builder	setUrl(String value) The URL of the import to be canonicalized.
OutboundMessage.CanonicalizeRequest.Builder	setUrlBytes(com.google.protobuf.ByteString value) The URL of the import to be canonicalized.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

clear

public OutboundMessage.CanonicalizeRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

getDefaultInstanceForType

public OutboundMessage.CanonicalizeRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public OutboundMessage.CanonicalizeRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public OutboundMessage.CanonicalizeRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public OutboundMessage.CanonicalizeRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

mergeFrom

public OutboundMessage.CanonicalizeRequest.Builder mergeFrom(OutboundMessage.CanonicalizeRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

mergeFrom

public OutboundMessage.CanonicalizeRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OutboundMessage.CanonicalizeRequest.Builder>

Throws:

IOException

getId

public int getId()

uint32 id = 1;

Specified by:

getId in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The id.

setId

public OutboundMessage.CanonicalizeRequest.Builder setId(int value)

uint32 id = 1;

Parameters:

value - The id to set.

Returns:

This builder for chaining.

clearId

public OutboundMessage.CanonicalizeRequest.Builder clearId()

uint32 id = 1;

Returns:

This builder for chaining.

getImporterId

public int getImporterId()

 The unique ID of the importer being invoked. This must match an importer
 ID passed to this compilation in `CompileRequest.importers` or
 `CompileRequest.input.string.importer`.
 

uint32 importer_id = 3;

Specified by:

getImporterId in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The importerId.

setImporterId

public OutboundMessage.CanonicalizeRequest.Builder setImporterId(int value)

 The unique ID of the importer being invoked. This must match an importer
 ID passed to this compilation in `CompileRequest.importers` or
 `CompileRequest.input.string.importer`.
 

uint32 importer_id = 3;

Parameters:

value - The importerId to set.

Returns:

This builder for chaining.

clearImporterId

public OutboundMessage.CanonicalizeRequest.Builder clearImporterId()

 The unique ID of the importer being invoked. This must match an importer
 ID passed to this compilation in `CompileRequest.importers` or
 `CompileRequest.input.string.importer`.
 

uint32 importer_id = 3;

Returns:

This builder for chaining.

getUrl

public String getUrl()

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Specified by:

getUrl in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The url.

getUrlBytes

public com.google.protobuf.ByteString getUrlBytes()

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Specified by:

getUrlBytes in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The bytes for url.

setUrl

public OutboundMessage.CanonicalizeRequest.Builder setUrl(String value)

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Parameters:

value - The url to set.

Returns:

This builder for chaining.

clearUrl

public OutboundMessage.CanonicalizeRequest.Builder clearUrl()

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Returns:

This builder for chaining.

setUrlBytes

public OutboundMessage.CanonicalizeRequest.Builder setUrlBytes(com.google.protobuf.ByteString value)

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Parameters:

value - The bytes for url to set.

Returns:

This builder for chaining.

getFromImport

public boolean getFromImport()

 Whether this request comes from an `@import` rule.

 When evaluating `@import` rules, URLs should canonicalize to an
 [import-only file] if one exists for the URL being canonicalized.
 Otherwise, canonicalization should be identical for `@import` and `@use`
 rules.

 [import-only file]: https://sass-lang.com/documentation/at-rules/import#import-only-files
 

bool from_import = 5;

Specified by:

getFromImport in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The fromImport.

setFromImport

public OutboundMessage.CanonicalizeRequest.Builder setFromImport(boolean value)

 Whether this request comes from an `@import` rule.

 When evaluating `@import` rules, URLs should canonicalize to an
 [import-only file] if one exists for the URL being canonicalized.
 Otherwise, canonicalization should be identical for `@import` and `@use`
 rules.

 [import-only file]: https://sass-lang.com/documentation/at-rules/import#import-only-files
 

bool from_import = 5;

Parameters:

value - The fromImport to set.

Returns:

This builder for chaining.

clearFromImport

public OutboundMessage.CanonicalizeRequest.Builder clearFromImport()

 Whether this request comes from an `@import` rule.

 When evaluating `@import` rules, URLs should canonicalize to an
 [import-only file] if one exists for the URL being canonicalized.
 Otherwise, canonicalization should be identical for `@import` and `@use`
 rules.

 [import-only file]: https://sass-lang.com/documentation/at-rules/import#import-only-files
 

bool from_import = 5;

Returns:

This builder for chaining.

hasContainingUrl

public boolean hasContainingUrl()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Specified by:

hasContainingUrl in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

Whether the containingUrl field is set.

getContainingUrl

public String getContainingUrl()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Specified by:

getContainingUrl in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The containingUrl.

getContainingUrlBytes

public com.google.protobuf.ByteString getContainingUrlBytes()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Specified by:

getContainingUrlBytes in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The bytes for containingUrl.

setContainingUrl

public OutboundMessage.CanonicalizeRequest.Builder setContainingUrl(String value)

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Parameters:

value - The containingUrl to set.

Returns:

This builder for chaining.

clearContainingUrl

public OutboundMessage.CanonicalizeRequest.Builder clearContainingUrl()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Returns:

This builder for chaining.

setContainingUrlBytes

public OutboundMessage.CanonicalizeRequest.Builder setContainingUrlBytes(com.google.protobuf.ByteString value)

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Parameters:

value - The bytes for containingUrl to set.

Returns:

This builder for chaining.