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
17package android.transition;
18
19import android.util.ArrayMap;
20import android.view.View;
21import android.view.ViewGroup;
22
23import java.util.Map;
24
25/**
26 * Data structure which holds cached values for the transition.
27 * The view field is the target which all of the values pertain to.
28 * The values field is a map which holds information for fields
29 * according to names selected by the transitions. These names should
30 * be unique to avoid clobbering values stored by other transitions,
31 * such as the convention project:transition_name:property_name. For
32 * example, the platform might store a property "alpha" in a transition
33 * "Fader" as "android:fader:alpha".
34 *
35 * <p>These values are cached during the
36 * {@link Transition#captureStartValues(TransitionValues)}
37 * capture} phases of a scene change, once when the start values are captured
38 * and again when the end values are captured. These start/end values are then
39 * passed into the transitions via the
40 * for {@link Transition#createAnimator(ViewGroup, TransitionValues, TransitionValues)}
41 * method.</p>
42 */
43public class TransitionValues {
44
45    /**
46     * The View with these values
47     */
48    public View view;
49
50    /**
51     * The set of values tracked by transitions for this scene
52     */
53    public final Map<String, Object> values = new ArrayMap<String, Object>();
54
55    @Override
56    public boolean equals(Object other) {
57        if (other instanceof TransitionValues) {
58            if (view == ((TransitionValues) other).view) {
59                if (values.equals(((TransitionValues) other).values)) {
60                    return true;
61                }
62            }
63        }
64        return false;
65    }
66
67    @Override
68    public int hashCode() {
69        return 31*view.hashCode() + values.hashCode();
70    }
71
72    @Override
73    public String toString() {
74        String returnValue = "TransitionValues@" + Integer.toHexString(hashCode()) + ":\n";
75        returnValue += "    view = " + view + "\n";
76        returnValue += "    values:";
77        for (String s : values.keySet()) {
78            returnValue += "    " + s + ": " + values.get(s) + "\n";
79        }
80        return returnValue;
81    }
82}