= Mode _(enum)_
:Notice: 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.

Controls whether the xref:refguide:applib:index/services/i18n/TranslationService.adoc[TranslationService] is enabled or disabled, and if enabled whether it is in write (learn) mode or read mode.

== API

[source,java]
.Mode.java
----
enum Mode {
  DISABLED     // <.>
  READ     // <.>
  WRITE     // <.>
  boolean matches(String configValue)
  boolean isRead()
  boolean isWrite()
  boolean isDisabled()
}
----

<.> xref:#DISABLED[DISABLED]
+
--
Translations are disabled.
--
<.> xref:#READ[READ]
+
--
Messages are being translated
--
<.> xref:#WRITE[WRITE]
+
--
Messages are _not_ being translated, but they are being recorded (such that a file of messages to be translated can be downloaded).
--

== Members

[#DISABLED]
=== DISABLED

Translations are disabled.

[#READ]
=== READ

Messages are being translated

[#WRITE]
=== WRITE

Messages are _not_ being translated, but they are being recorded (such that a file of messages to be translated can be downloaded).
