io.getstream.result.internal.StreamHandsOff.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stream-result Show documentation

Result and error models for standardizing responses on Kotlin and Android.

There is a newer version: 1.3.2

/*
 * Copyright (c) 2014-2023 Stream.io Inc. All rights reserved.
 *
 * 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 io.getstream.result.internal

/**
 * Indicates that the annotated code should not be modified without consulting the team.
 * @param reason
 * For example:
 *
 *  * @StreamHandsOff(reason = "If you move a card, the house is collapsed")
 * public class HouseOfCards { }
 *
 */
@MustBeDocumented
@Retention(AnnotationRetention.RUNTIME)
public annotation class StreamHandsOff(val reason: String)