Stay organized with collections
Save and categorize content based on your preferences.
interface Freezable
<T>
Interface for data objects that support being frozen into immutable representations.
Summary
Public functions
fun freeze
(): T
Freeze a volatile representation into an immutable representation. Objects returned from this call are safe to cache.
Note that the output of freeze
may not be identical to the parent object, but should be equal. In other words:
Freezable
f1
=
new
Freezable
();
Freezable
f2
=
f1
.
freeze
();
f1
==
f2
may
not
be
true
.
f1
.
equals
(
f2
)
will
be
true
.
fun isDataValid
(): Boolean
Check to see if this object is valid for use. If the object is still volatile, this method will indicate whether or not the object can be safely used. The output of a call to freeze
will always be valid.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eFreezable\u003c/code\u003e interface allows data objects to be frozen into immutable representations for caching and safe usage.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efreeze()\u003c/code\u003e creates an immutable copy of the object, ensuring data integrity; while the frozen copy may not be identical to the original, it will be equal in value.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eisDataValid()\u003c/code\u003e checks if the object is safe to use, especially important for volatile objects before they are frozen.\u003c/p\u003e\n"]]],[],null,["# Freezable\n=========\n\nKotlin \\|[Java](/android/reference/com/google/android/gms/common/data/Freezable \"View this page in Java\") \n\n\n```\ninterface Freezable\u003cT\u003e\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nInterface for data objects that support being frozen into immutable representations.\n\nSummary\n-------\n\n| ### Public functions |\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `T` | [freeze](/android/reference/kotlin/com/google/android/gms/common/data/Freezable#freeze())`()` Freeze a volatile representation into an immutable representation. |\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isDataValid](/android/reference/kotlin/com/google/android/gms/common/data/Freezable#isDataValid())`()` Check to see if this object is valid for use. |\n\nPublic functions\n----------------\n\n### freeze\n\n```\nfun freeze(): T\n```\n\nFreeze a volatile representation into an immutable representation. Objects returned from this call are safe to cache.\n\nNote that the output of `freeze` may not be identical to the parent object, but should be equal. In other words: \n\n```kotlin\nFreezable f1 = new Freezable();\nFreezable f2 = f1.freeze();\nf1 == f2 may not be true.\nf1.equals(f2) will be true.\n``` \n\n| Returns |\n|---------|-----------------------------------------------|\n| `T` | A concrete implementation of the data object. |\n\n### isDataValid\n\n```\nfun isDataValid(): Boolean\n```\n\nCheck to see if this object is valid for use. If the object is still volatile, this method will indicate whether or not the object can be safely used. The output of a call to [freeze](/android/reference/kotlin/com/google/android/gms/common/data/Freezable#freeze()) will always be valid. \n\n| Returns |\n|------------------------------------------------------------------------------------|---------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | whether or not the object is valid for use. |"]]
