car-stream-lib/src/com/android/car/stream/StreamCardExtension.java

/*
 * Copyright (c) 2016, 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 com.android.car.stream;

/**
 * A base class for extensions to {@link StreamCard}.
 *
 * <p>
 * {@link StreamCard} allows for additional fields to be included in the template through the
 * use of extensions. Extensions should hold data specific for the type of {@link StreamCard}
 * it is extending.
 *
 * Example:
 *
 * public class CurrentCallExtension extends StreamCardExtension {
 *         private long mCallStartTime;
 *         private String mDisplayName;
 *
 *         public static final Creator<CurrentCallExtension> CREATOR
 *                  = new BundleableCreator<>(CurrentCallExtension.class);
 *
 *         @Override
 *         protected void writeToBundle(Bundle bundle) {...}
 *
 *         @Override
 *         protected void readFromBundle(Bundle bundle) {...}
 *
 * }
 * </p>
 *
 *
 */
public abstract class StreamCardExtension extends AbstractBundleable {
}