summaryrefslogtreecommitdiff
path: root/subversion/bindings/javahl/native/jniwrapper/jni_string_map.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'subversion/bindings/javahl/native/jniwrapper/jni_string_map.hpp')
-rw-r--r--subversion/bindings/javahl/native/jniwrapper/jni_string_map.hpp384
1 files changed, 384 insertions, 0 deletions
diff --git a/subversion/bindings/javahl/native/jniwrapper/jni_string_map.hpp b/subversion/bindings/javahl/native/jniwrapper/jni_string_map.hpp
new file mode 100644
index 0000000..db05e28
--- /dev/null
+++ b/subversion/bindings/javahl/native/jniwrapper/jni_string_map.hpp
@@ -0,0 +1,384 @@
+/**
+ * @copyright
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ * ====================================================================
+ * @endcopyright
+ */
+
+#ifndef SVN_JAVAHL_JNIWRAPPER_STRING_MAP_HPP
+#define SVN_JAVAHL_JNIWRAPPER_STRING_MAP_HPP
+
+#include <string>
+
+#include "jni_env.hpp"
+#include "jni_object.hpp"
+#include "jni_iterator.hpp"
+
+namespace Java {
+
+/**
+ * Non-template base for an immutable type-safe Java map with String keys.
+ *
+ * @since New in 1.9.
+ */
+class BaseImmutableMap : public Object
+{
+public:
+ /**
+ * Returns the number of elements in the map.
+ */
+ jint length() const
+ {
+ return m_env.CallIntMethod(m_jthis, impl().m_mid_size);
+ }
+
+ /**
+ * Checks if the map is empty.
+ */
+ bool is_empty() const
+ {
+ return (length() == 0);
+ }
+
+protected:
+ /**
+ * Constructs the map wrapper.
+ */
+ explicit BaseImmutableMap(Env env, jobject jmap)
+ : Object(env, ClassCache::get_map(env), jmap)
+ {}
+
+ /**
+ * Constructor used by BaseMap.
+ */
+ explicit BaseImmutableMap(Env env, const Object::ClassImpl* pimpl)
+ : Object(env, pimpl)
+ {}
+
+ /**
+ * Clears the contents of the map.
+ */
+ void clear()
+ {
+ m_env.CallVoidMethod(m_jthis, impl().m_mid_clear);
+ }
+
+ /**
+ * Inserts @a obj identified by @a key into the map.
+ */
+ void put(const std::string& key, jobject obj)
+ {
+ m_env.CallObjectMethod(m_jthis, impl().m_mid_put,
+ String(m_env, key).get(), obj);
+ }
+
+ /**
+ * Returns the object reference identified by @a index.
+ * @throw std::out_of_range if there is no such element.
+ */
+ jobject operator[](const std::string& index) const;
+
+ /**
+ * This object's implementation details.
+ */
+ class ClassImpl : public Object::ClassImpl
+ {
+ friend class ClassCacheImpl;
+
+ protected:
+ explicit ClassImpl(Env env, jclass cls);
+
+ public:
+ virtual ~ClassImpl();
+
+ const MethodID m_mid_put;
+ const MethodID m_mid_clear;
+ const MethodID m_mid_has_key;
+ const MethodID m_mid_get;
+ const MethodID m_mid_size;
+ const MethodID m_mid_entry_set;
+ };
+
+ const ClassImpl& impl() const
+ {
+ return *dynamic_cast<const ClassImpl*>(m_impl);
+ }
+
+ friend class ClassCacheImpl;
+ static const char* const m_class_name;
+
+ class Iterator : public BaseIterator
+ {
+ friend class BaseImmutableMap;
+ explicit Iterator(Env env, jobject jiterator)
+ : BaseIterator(env, jiterator)
+ {}
+ };
+
+ Iterator get_iterator() const;
+
+ class Entry : public Object
+ {
+ public:
+ explicit Entry(Env env, jobject jentry)
+ : Object(env, ClassCache::get_map_entry(env), jentry)
+ {}
+
+ const std::string key() const
+ {
+ const jstring jkey =
+ jstring(m_env.CallObjectMethod(m_jthis, impl().m_mid_get_key));
+ const String::Contents key(String(m_env, jkey));
+ return std::string(key.c_str());
+ }
+
+ jobject value() const
+ {
+ return m_env.CallObjectMethod(m_jthis, impl().m_mid_get_value);
+ }
+
+ private:
+ /**
+ * This object's implementation details.
+ */
+ class ClassImpl : public Object::ClassImpl
+ {
+ friend class ClassCacheImpl;
+
+ protected:
+ explicit ClassImpl(Env env, jclass cls);
+
+ public:
+ virtual ~ClassImpl();
+
+ const MethodID m_mid_get_key;
+ const MethodID m_mid_get_value;
+ };
+
+ friend class ClassCacheImpl;
+ static const char* const m_class_name;
+ const ClassImpl& impl() const
+ {
+ return *dynamic_cast<const ClassImpl*>(m_impl);
+ }
+ };
+
+private:
+ struct Set
+ {
+ /**
+ * This object's implementation details.
+ */
+ class ClassImpl : public Object::ClassImpl
+ {
+ friend class ClassCacheImpl;
+
+ protected:
+ explicit ClassImpl(Env env, jclass cls);
+
+ public:
+ virtual ~ClassImpl();
+
+ const MethodID m_mid_iterator;
+ };
+
+ static const char* const m_class_name;
+ static const ClassImpl& impl(Env env)
+ {
+ return *dynamic_cast<const ClassImpl*>(ClassCache::get_set(env));
+ }
+ };
+};
+
+/**
+ * Template wrapper for an immutable type-safe Java map.
+ *
+ * @since New in 1.9.
+ */
+template <typename T, typename NativeT=jobject>
+class ImmutableMap : public BaseImmutableMap
+{
+public:
+ /**
+ * Constructs the map wrapper, converting the contents to an
+ * @c std::map.
+ */
+ explicit ImmutableMap(Env env, jobject jmap)
+ : BaseImmutableMap(env, jmap)
+ {}
+
+ /**
+ * Returns a wrapper object for the object reference identified by @a index.
+ * @throw std::out_of_range if there is no such element.
+ */
+ T operator[](const std::string& index) const
+ {
+ return T(m_env, NativeT(BaseImmutableMap::operator[](index)));
+ }
+
+ /**
+ * Iterates over the items in the map, calling @a function for
+ * each item.
+ * @see std::for_each
+ * @note Unlike std::for_each, which invokes the functor with a
+ * single @c value_type argument, this iterator calls
+ * @a function with separate @c const references to the key
+ * and value.
+ */
+ template<typename F>
+ F for_each(F function) const
+ {
+ Iterator iter(get_iterator());
+ while (iter.has_next())
+ {
+ Entry entry(m_env, iter.next());
+ const std::string& key(entry.key());
+ function(key, T(m_env, NativeT(entry.value())));
+ }
+ return function;
+ }
+};
+
+/**
+ * Non-template base for a mutable type-safe Java map with String keys.
+ *
+ * @since New in 1.9.
+ */
+class BaseMap : public BaseImmutableMap
+{
+public:
+ /**
+ * Clears the contents of the map.
+ */
+ void clear()
+ {
+ BaseImmutableMap::clear();
+ }
+
+protected:
+ /**
+ * Constructs the map wrapper, treating @a jmap as a @c java.util.Map.
+ */
+ explicit BaseMap(Env env, jobject jmap)
+ : BaseImmutableMap(env, jmap)
+ {}
+
+ /**
+ * Constructs and wraps an empty map of type @c java.util.HashMap
+ * with initial allocation size @a length.
+ */
+ explicit BaseMap(Env env, jint length)
+ : BaseImmutableMap(env, ClassCache::get_hash_map(env))
+ {
+ set_this(env.NewObject(get_class(), impl().m_mid_ctor, length));
+ }
+
+private:
+ /**
+ * This object's implementation details.
+ */
+ class ClassImpl : public BaseImmutableMap::ClassImpl
+ {
+ friend class ClassCacheImpl;
+
+ protected:
+ explicit ClassImpl(Env env, jclass cls);
+
+ public:
+ virtual ~ClassImpl();
+
+ const MethodID m_mid_ctor;
+ };
+
+ const ClassImpl& impl() const
+ {
+ return *dynamic_cast<const ClassImpl*>(m_impl);
+ }
+
+ friend class ClassCacheImpl;
+ static const char* const m_class_name;
+};
+
+/**
+ * Template wrapper for a mutable type-safe Java map.
+ *
+ * @since New in 1.9.
+ */
+template <typename T, typename NativeT=jobject>
+class Map : public BaseMap
+{
+public:
+ /**
+ * Constructs the map wrapper, deriving the class from @a jmap.
+ */
+ explicit Map(Env env, jobject jmap)
+ : BaseMap(env, jmap)
+ {}
+
+ /**
+ * Constructs and wraps an empty map of type @c java.util.HashMap
+ * with initial allocation size @a length.
+ */
+ explicit Map(Env env, jint length = 0)
+ : BaseMap(env, length)
+ {}
+
+ /**
+ * Inserts @a obj identified by @a key into the map.
+ */
+ void put(const std::string& key, const T& obj)
+ {
+ BaseMap::put(key, obj.get());
+ }
+
+ /**
+ * Returns a wrapper object for the object reference identified by @a index.
+ * @throw std::out_of_range if there is no such element.
+ */
+ T operator[](const std::string& index) const
+ {
+ return T(m_env, NativeT(BaseMap::operator[](index)));
+ }
+
+ /**
+ * Iterates over the items in the map, calling @a function for
+ * each item.
+ * @see std::for_each
+ * @note Unlike std::for_each, which invokes the functor with a
+ * single @c value_type argument, this iterator calls
+ * @a function with separate @c const references to the key
+ * and value.
+ */
+ template<typename F>
+ F for_each(F function) const
+ {
+ Iterator iter(get_iterator());
+ while (iter.has_next())
+ {
+ Entry entry(m_env, iter.next());
+ const std::string& key(entry.key());
+ function(key, T(m_env, NativeT(entry.value())));
+ }
+ return function;
+ }
+};
+
+} // namespace Java
+
+#endif // SVN_JAVAHL_JNIWRAPPER_STRING_MAP_HPP