iOS/Pods/FirebaseCore/Firebase/Core/Private/FIRDependency.h

   1 /*
   2  * Copyright 2018 Google
   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 #import <Foundation/Foundation.h>
  18
  19 NS_ASSUME_NONNULL_BEGIN
  20
  21 /// A dependency on a specific protocol's functionality.
  22 NS_SWIFT_NAME(Dependency)
  23 @interface FIRDependency : NSObject
  24
  25 /// The protocol describing functionality being depended on.
  26 @property(nonatomic, strong, readonly) Protocol *protocol;
  27
  28 /// A flag to specify if the dependency is required or not.
  29 @property(nonatomic, readonly) BOOL isRequired;
  30
  31 /// Initializes a dependency that is required. Calls `initWithProtocol:isRequired` with `YES` for
  32 /// the required parameter.
  33 /// Creates a required dependency on the specified protocol's functionality.
  34 + (instancetype)dependencyWithProtocol:(Protocol *)protocol;
  35
  36 /// Creates a dependency on the specified protocol's functionality and specify if it's required for
  37 /// the class's functionality.
  38 + (instancetype)dependencyWithProtocol:(Protocol *)protocol isRequired:(BOOL)required;
  39
  40 /// Use `dependencyWithProtocol:isRequired:` instead.
  41 - (instancetype)init NS_UNAVAILABLE;
  42
  43 @end
  44
  45 NS_ASSUME_NONNULL_END