001/*
002 * Copyright 2017-2022 Product Mog LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.lokalized;
018
019/**
020 * Controls whether Lokalized wraps caller-supplied placeholder values with Unicode bidirectional isolate controls.
021 *
022 * @author <a href="https://revetkn.com">Mark Allen</a>
023 * @since 3.0.0
024 */
025public enum BidiIsolation {
026  /**
027   * Do not add bidirectional isolate controls.
028   */
029  NONE,
030  /**
031   * In every resolved locale, wrap caller-supplied placeholder values with
032   * First Strong Isolate (U+2068) and Pop Directional Isolate (U+2069).
033   * <p>
034   * This protects right-to-left values embedded in left-to-right translations as well as the inverse case.
035   */
036  ALWAYS,
037  /**
038   * In right-to-left resolved locales, wrap caller-supplied placeholder values with
039   * First Strong Isolate (U+2068) and Pop Directional Isolate (U+2069).
040   */
041  RTL_LOCALES
042}