1 /*
2  * Copyright (C) 2024 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.ink.geometry
18 
19 import androidx.annotation.RestrictTo
20 
21 /**
22  * Represents a directed line segment between two points. See [MutableSegment] for mutable
23  * alternative.
24  */
25 public class ImmutableSegment(start: Vec, end: Vec) : Segment() {
26 
27     @Suppress("Immutable") override val start: Vec = start.asImmutable()
28     @Suppress("Immutable") override val end: Vec = end.asImmutable()
29 
asImmutablenull30     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) override fun asImmutable(): ImmutableSegment = this
31 
32     override fun equals(other: Any?): Boolean =
33         other === this || (other is Segment && areEquivalent(this, other))
34 
35     // NOMUTANTS -- not testing exact hashCode values, just that equality implies same hashCode
36     override fun hashCode(): Int = hash(this)
37 
38     override fun toString(): String = "Immutable${string(this)}"
39 }
40