• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2013 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 android.transition;
18 
19 import android.annotation.NonNull;
20 import android.annotation.Nullable;
21 import android.util.ArrayMap;
22 import android.view.View;
23 import android.view.ViewGroup;
24 
25 import java.util.ArrayList;
26 import java.util.Map;
27 
28 /**
29  * Data structure which holds cached values for the transition.
30  * The view field is the target which all of the values pertain to.
31  * The values field is a map which holds information for fields
32  * according to names selected by the transitions. These names should
33  * be unique to avoid clobbering values stored by other transitions,
34  * such as the convention project:transition_name:property_name. For
35  * example, the platform might store a property "alpha" in a transition
36  * "Fader" as "android:fader:alpha".
37  *
38  * <p>These values are cached during the
39  * {@link Transition#captureStartValues(TransitionValues)}
40  * capture} phases of a scene change, once when the start values are captured
41  * and again when the end values are captured. These start/end values are then
42  * passed into the transitions via the
43  * for {@link Transition#createAnimator(ViewGroup, TransitionValues, TransitionValues)}
44  * method.</p>
45  */
46 public class TransitionValues {
47 
48     /** @deprecated Use {@link #TransitionValues(View)} instead */
49     @Deprecated
TransitionValues()50     public TransitionValues() {
51     }
52 
TransitionValues(@onNull View view)53     public TransitionValues(@NonNull View view) {
54         this.view = view;
55     }
56 
57     /**
58      * The View with these values
59      */
60     @SuppressWarnings("NullableProblems") // Can't make it final because of deprecated constructor.
61     @NonNull
62     public View view;
63 
64     /**
65      * The set of values tracked by transitions for this scene
66      */
67     @NonNull
68     public final Map<String, Object> values = new ArrayMap<String, Object>();
69 
70     /**
71      * The Transitions that targeted this view.
72      */
73     @NonNull
74     final ArrayList<Transition> targetedTransitions = new ArrayList<Transition>();
75 
76     @Override
equals(@ullable Object other)77     public boolean equals(@Nullable Object other) {
78         if (other instanceof TransitionValues) {
79             if (view == ((TransitionValues) other).view) {
80                 if (values.equals(((TransitionValues) other).values)) {
81                     return true;
82                 }
83             }
84         }
85         return false;
86     }
87 
88     @Override
hashCode()89     public int hashCode() {
90         return 31*view.hashCode() + values.hashCode();
91     }
92 
93     @Override
toString()94     public String toString() {
95         String returnValue = "TransitionValues@" + Integer.toHexString(hashCode()) + ":\n";
96         returnValue += "    view = " + view + "\n";
97         returnValue += "    values:";
98         for (String s : values.keySet()) {
99             returnValue += "    " + s + ": " + values.get(s) + "\n";
100         }
101         return returnValue;
102     }
103 }