OutboundMessage.FileImportRequest.Builder (sass-embedded-protocol 3.7.3 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.FileImportRequest.Builder>
    - - com.sass_lang.embedded_protocol.OutboundMessage.FileImportRequest.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutboundMessage.FileImportRequestOrBuilder, Cloneable

Enclosing class:: OutboundMessage.FileImportRequest

public static final class OutboundMessage.FileImportRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<OutboundMessage.FileImportRequest.Builder>
implements OutboundMessage.FileImportRequestOrBuilder

 A request for a custom filesystem importer to load the contents of a
 stylesheet.

 A filesystem importer is represented in the compiler as an [importer]. When
 the importer is invoked with a string `string`:

 [importer]: https://github.com/sass/sass/tree/main/spec/modules.md#importer

 * If `string` is an absolute URL whose scheme is `file`:

 * Let `url` be string.

 * Otherwise:

 * Let `fromImport` be `true` if the importer is being run for an
 `@import` and `false` otherwise.

 * Let `containingUrl` be the canonical URL of the [current source file]
 if it has one, or undefined otherwise.


 * Let `response` be the result of sending a `FileImportRequest` with
 `string` as its `url`, `fromImport` as `from_import`, and
 `containingUrl` as `containing_url`.

 * If `response.result` is null, return null.

 * Otherwise, if `response.result.error` is set, throw an error.

 * Otherwise, let `url` be `response.result.file_url`.

 * Let `resolved` be the result of [resolving `url`].

 * If `resolved` is null, return null.

 * Let `text` be the contents of the file at `resolved`.

 * Let `syntax` be:
 * "scss" if `url` ends in `.scss`.
 * "indented" if `url` ends in `.sass`.
 * "css" if `url` ends in `.css`.

 > The algorithm for resolving a `file:` URL guarantees that `url` will have
 > one of these extensions.

 * Return `text`, `syntax`, and `resolved`.

 [current source file]: ../spec.md#current-source-file
 [resolving `url`]: https://github.com/sass/sass/tree/main/spec/modules.md#resolving-a-file-url

Protobuf type sass.embedded_protocol.OutboundMessage.FileImportRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OutboundMessage.FileImportRequest`	`build()`
`OutboundMessage.FileImportRequest`	`buildPartial()`
`OutboundMessage.FileImportRequest.Builder`	`clear()`
`OutboundMessage.FileImportRequest.Builder`	`clearContainingUrl()` The canonical URL of the [current source file] that contained the load being resolved.
`OutboundMessage.FileImportRequest.Builder`	`clearFromImport()` Whether this request comes from an `@import` rule.
`OutboundMessage.FileImportRequest.Builder`	`clearId()` `uint32 id = 1;`
`OutboundMessage.FileImportRequest.Builder`	`clearImporterId()` The unique ID of the importer being invoked.
`OutboundMessage.FileImportRequest.Builder`	`clearUrl()` The (non-canonicalized) URL of the import.
`String`	`getContainingUrl()` The canonical URL of the [current source file] that contained the load being resolved.
`com.google.protobuf.ByteString`	`getContainingUrlBytes()` The canonical URL of the [current source file] that contained the load being resolved.
`OutboundMessage.FileImportRequest`	`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 (non-canonicalized) URL of the import.
`com.google.protobuf.ByteString`	`getUrlBytes()` The (non-canonicalized) URL of the import.
`boolean`	`hasContainingUrl()` The canonical URL of the [current source file] that contained the load being resolved.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`OutboundMessage.FileImportRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`OutboundMessage.FileImportRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`OutboundMessage.FileImportRequest.Builder`	`mergeFrom(OutboundMessage.FileImportRequest other)`
`OutboundMessage.FileImportRequest.Builder`	`setContainingUrl(String value)` The canonical URL of the [current source file] that contained the load being resolved.
`OutboundMessage.FileImportRequest.Builder`	`setContainingUrlBytes(com.google.protobuf.ByteString value)` The canonical URL of the [current source file] that contained the load being resolved.
`OutboundMessage.FileImportRequest.Builder`	`setFromImport(boolean value)` Whether this request comes from an `@import` rule.
`OutboundMessage.FileImportRequest.Builder`	`setId(int value)` `uint32 id = 1;`
`OutboundMessage.FileImportRequest.Builder`	`setImporterId(int value)` The unique ID of the importer being invoked.
`OutboundMessage.FileImportRequest.Builder`	`setUrl(String value)` The (non-canonicalized) URL of the import.
`OutboundMessage.FileImportRequest.Builder`	`setUrlBytes(com.google.protobuf.ByteString value)` The (non-canonicalized) URL of the import.

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.FileImportRequest.Builder>

clear
```
public OutboundMessage.FileImportRequest.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.FileImportRequest.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.FileImportRequest.Builder>

getDefaultInstanceForType
```
public OutboundMessage.FileImportRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public OutboundMessage.FileImportRequest build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public OutboundMessage.FileImportRequest buildPartial()
```
Specified by:

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

Specified by:

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

mergeFrom
```
public OutboundMessage.FileImportRequest.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.FileImportRequest.Builder>

mergeFrom

public OutboundMessage.FileImportRequest.Builder mergeFrom(OutboundMessage.FileImportRequest 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.FileImportRequest.Builder>

mergeFrom

public OutboundMessage.FileImportRequest.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.FileImportRequest.Builder>
Throws:: IOException

getId
```
public int getId()
```
uint32 id = 1;

Specified by:

getId in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The id.

setId
```
public OutboundMessage.FileImportRequest.Builder setId(int value)
```
uint32 id = 1;

Parameters:

value - The id to set.

Returns:

This builder for chaining.

clearId

public OutboundMessage.FileImportRequest.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.file_importer_id` passed to this compilation in
 `CompileRequest.importers` or `CompileRequest.input.string.importer`.

uint32 importer_id = 3;

Specified by:: getImporterId in interface OutboundMessage.FileImportRequestOrBuilder
Returns:: The importerId.

setImporterId

public OutboundMessage.FileImportRequest.Builder setImporterId(int value)

 The unique ID of the importer being invoked. This must match an
 `Importer.file_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.FileImportRequest.Builder clearImporterId()

 The unique ID of the importer being invoked. This must match an
 `Importer.file_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 (non-canonicalized) URL of the import.
 
```
string url = 4;
Specified by:

getUrl in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The url.

getUrlBytes
```
public com.google.protobuf.ByteString getUrlBytes()
```
```
 The (non-canonicalized) URL of the import.
 
```
string url = 4;
Specified by:

getUrlBytes in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The bytes for url.

setUrl

public OutboundMessage.FileImportRequest.Builder setUrl(String value)

 The (non-canonicalized) URL of the import.

string url = 4;

Parameters:: value - The url to set.
Returns:: This builder for chaining.

clearUrl

public OutboundMessage.FileImportRequest.Builder clearUrl()

 The (non-canonicalized) URL of the import.

string url = 4;

Returns:: This builder for chaining.

setUrlBytes

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

 The (non-canonicalized) URL 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, filesystem importers should load 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.FileImportRequestOrBuilder
Returns:: The fromImport.

setFromImport

public OutboundMessage.FileImportRequest.Builder setFromImport(boolean value)

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

 When evaluating `@import` rules, filesystem importers should load 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.FileImportRequest.Builder clearFromImport()

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

 When evaluating `@import` rules, filesystem importers should load 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.