From 97cc96839d31b6cce59ec29a6681c6fe802552ee Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Fri, 17 Oct 2014 00:06:56 +0400
Subject: initial

---
 .../com/twofortyfouram/locale/BreadCrumber.java    | 90 ++++++++++++++++++++++
 1 file changed, 90 insertions(+)
 create mode 100644 taskerlocaleapi/src/main/java/com/twofortyfouram/locale/BreadCrumber.java

(limited to 'taskerlocaleapi/src/main/java/com/twofortyfouram/locale/BreadCrumber.java')

diff --git a/taskerlocaleapi/src/main/java/com/twofortyfouram/locale/BreadCrumber.java b/taskerlocaleapi/src/main/java/com/twofortyfouram/locale/BreadCrumber.java
new file mode 100644
index 00000000..6363982f
--- /dev/null
+++ b/taskerlocaleapi/src/main/java/com/twofortyfouram/locale/BreadCrumber.java
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2013 two forty four a.m. LLC <http://www.twofortyfouram.com>
+ *
+ * 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.twofortyfouram.locale;
+
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+import com.twofortyfouram.locale.api.R;
+
+/**
+ * Utility class to generate a breadcrumb title string for {@code Activity} instances in Locale.
+ * <p>
+ * This class cannot be instantiated.
+ */
+public final class BreadCrumber
+{
+    /**
+     * Static helper method to generate bread crumbs. Bread crumb strings will be properly formatted for the
+     * current language, including right-to-left languages, as long as the proper
+     * {@link com.twofortyfouram.locale.platform.R.string#twofortyfouram_locale_breadcrumb_format} string
+     * resources have been created.
+     *
+     * @param context {@code Context} for loading platform resources. Cannot be null.
+     * @param intent {@code Intent} to extract the bread crumb from.
+     * @param currentCrumb The last element of the bread crumb path.
+     * @return {@code String} presentation of the bread crumb. If the intent parameter is null, then this
+     *         method returns currentCrumb. If currentCrumb is null, then this method returns the empty string
+     *         "". If intent contains a private Serializable instances as an extra, then this method returns
+     *         the empty string "".
+     * @throws IllegalArgumentException if {@code context} is null.
+     */
+    public static CharSequence generateBreadcrumb(final Context context, final Intent intent,
+                                                  final String currentCrumb)
+    {
+        if (null == context)
+        {
+            throw new IllegalArgumentException("context cannot be null"); //$NON-NLS-1$
+        }
+
+        try
+        {
+            if (null == currentCrumb)
+            {
+                Log.w(Constants.LOG_TAG, "currentCrumb cannot be null"); //$NON-NLS-1$
+                return ""; //$NON-NLS-1$
+            }
+            if (null == intent)
+            {
+                Log.w(Constants.LOG_TAG, "intent cannot be null"); //$NON-NLS-1$
+                return currentCrumb;
+            }
+
+            /*
+             * Note: this is vulnerable to a private serializable attack, but the try-catch will solve that.
+             */
+            final String breadcrumbString = intent.getStringExtra(com.twofortyfouram.locale.Intent.EXTRA_STRING_BREADCRUMB);
+            if (null != breadcrumbString)
+            {
+                return context.getString(R.string.twofortyfouram_locale_breadcrumb_format, breadcrumbString, context.getString(R.string.twofortyfouram_locale_breadcrumb_separator), currentCrumb);
+            }
+            return currentCrumb;
+        }
+        catch (final Exception e)
+        {
+            Log.e(Constants.LOG_TAG, "Encountered error generating breadcrumb", e); //$NON-NLS-1$
+            return ""; //$NON-NLS-1$
+        }
+    }
+
+    /**
+     * Private constructor prevents instantiation.
+     *
+     * @throws UnsupportedOperationException because this class cannot be instantiated.
+     */
+    private BreadCrumber()
+    {
+        throw new UnsupportedOperationException("This class is non-instantiable"); //$NON-NLS-1$
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.3