IsolateStartupParameters.java
/*
* Copyright 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.javascriptengine;
import androidx.annotation.IntRange;
import androidx.annotation.RequiresFeature;
/**
* Class used to set startup parameters for {@link JavaScriptIsolate}.
*/
public final class IsolateStartupParameters {
private long mMaxHeapSizeBytes;
public static final long DEFAULT_ISOLATE_HEAP_SIZE = 0;
public IsolateStartupParameters(){};
/**
* Sets the max heap size used by the {@link JavaScriptIsolate}.
*
* A heap size of {@link IsolateStartupParameters#DEFAULT_ISOLATE_HEAP_SIZE} indicates no
* limit.
* <p>
* If a value higher than the device specific maximum heap size limit is supplied, this limit
* will be used as the maximum heap size.
*
* @param size heap size in bytes
*/
@RequiresFeature(name = JavaScriptSandbox.JS_FEATURE_ISOLATE_MAX_HEAP_SIZE,
enforcement =
"androidx.javascriptengine.JavaScriptSandbox#isFeatureSupported")
public void setMaxHeapSizeBytes(@IntRange(from = 0) long size) {
if (size < 0) {
throw new IllegalArgumentException("maxHeapSizeBytes should be >= 0");
}
mMaxHeapSizeBytes = size;
}
/**
* Gets the max heap size used by the {@link JavaScriptIsolate}.
*
* If not set using {@link IsolateStartupParameters#setMaxHeapSizeBytes(long)}, the default
* value is {@link IsolateStartupParameters#DEFAULT_ISOLATE_HEAP_SIZE} which indicates no heap
* size limit.
*
* @return heap size in bytes
*/
public @IntRange(from = 0) long getMaxHeapSizeBytes() {
return mMaxHeapSizeBytes;
}
}