= Recognition _(record)_
: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.

Represents a user-friendly representation of an exception that has been recognised by an available implementation of an xref:refguide:applib:index/services/exceprecog/ExceptionRecognizer.adoc[ExceptionRecognizer] .

Returned by _ExceptionRecognizer#recognize(Throwable)_ when the exception recognizer has recognised the exception

== API

[source,java]
.Recognition.java
----
record Recognition {
  Optional<Recognition> of(Category category, String reason)     // <.>
  String toMessage(TranslationService translationService)     // <.>
  String toMessageNoCategory(TranslationService translationService)     // <.>
}
----

<.> xref:#of_Category_String[of(Category, String)]
<.> xref:#toMessage_TranslationService[toMessage(TranslationService)]
+
--
Translates the _#reason() reason_ and prepends with a translation of _#category() category_ , using the provided xref:refguide:applib:index/services/i18n/TranslationService.adoc[TranslationService] ..
--
<.> xref:#toMessageNoCategory_TranslationService[toMessageNoCategory(TranslationService)]
+
--
Translates the _#reason() reason_ alone (ignoring the _#category() category_ , using the provided xref:refguide:applib:index/services/i18n/TranslationService.adoc[TranslationService] ..
--

== Members

[#of_Category_String]
=== of(Category, String)

[#toMessage_TranslationService]
=== toMessage(TranslationService)

Translates the _#reason() reason_ and prepends with a translation of _#category() category_ , using the provided xref:refguide:applib:index/services/i18n/TranslationService.adoc[TranslationService] ..

[#toMessageNoCategory_TranslationService]
=== toMessageNoCategory(TranslationService)

Translates the _#reason() reason_ alone (ignoring the _#category() category_ , using the provided xref:refguide:applib:index/services/i18n/TranslationService.adoc[TranslationService] ..
