aboutsummaryrefslogtreecommitdiff
path: root/cpp/include/libaddressinput/supplier.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/include/libaddressinput/supplier.h')
-rw-r--r--cpp/include/libaddressinput/supplier.h55
1 files changed, 55 insertions, 0 deletions
diff --git a/cpp/include/libaddressinput/supplier.h b/cpp/include/libaddressinput/supplier.h
new file mode 100644
index 0000000..fcd64ad
--- /dev/null
+++ b/cpp/include/libaddressinput/supplier.h
@@ -0,0 +1,55 @@
+// Copyright (C) 2014 Google Inc.
+//
+// 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.
+
+#ifndef I18N_ADDRESSINPUT_SUPPLIER_H_
+#define I18N_ADDRESSINPUT_SUPPLIER_H_
+
+#include <libaddressinput/callback.h>
+#include <libaddressinput/util/basictypes.h>
+
+namespace i18n {
+namespace addressinput {
+
+class LookupKey;
+class Rule;
+
+// Interface for objects that are able to supply the AddressValidator with the
+// metadata needed to validate an address, as described by a LookupKey.
+class Supplier {
+ public:
+ struct RuleHierarchy;
+ typedef i18n::addressinput::Callback<const LookupKey&,
+ const RuleHierarchy&> Callback;
+
+ virtual ~Supplier() {}
+
+ // Aggregates the metadata needed for |lookup_key| into a RuleHierarchy
+ // object, then calls |supplied|. Implementations of this interface may
+ // either load the necessary data on demand, or fail if the necessary data
+ // hasn't already been loaded.
+ virtual void Supply(const LookupKey& lookup_key,
+ const Callback& supplied) = 0;
+
+ // A RuleHierarchy object encapsulates the hierarchical list of Rule objects
+ // that corresponds to a particular LookupKey.
+ struct RuleHierarchy {
+ RuleHierarchy() : rule() {}
+ const Rule* rule[4]; // Cf. LookupKey::kHierarchy.
+ };
+};
+
+} // namespace addressinput
+} // namespace i18n
+
+#endif // I18N_ADDRESSINPUT_SUPPLIER_H_