= Clob _(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 character large object.

Conceptually you can consider it as a set of characters (an RTF or XML document, for example), though in fact it wraps three pieces of information:

* the set of characters
* a name
* a mime type

== API

[source,java]
.Clob.java
----
record Clob {
  Clob(String name, String primaryType, String subType, char[] chars)
  Clob(String name, String mimeTypeBase, char[] chars)
  Clob(String name, MimeType mimeType, char[] chars)
  Clob(String name, String primaryType, String subType, CharSequence chars)
  Clob(String name, String mimeTypeBase, CharSequence chars)
  Clob(String name, MimeType mimeType, CharSequence chars)
  Clob of(String name, CommonMimeType mimeType, CharSequence content)     // <.>
  Try<Clob> tryRead(String name, CommonMimeType mimeType, DataSource dataSource, Charset charset)     // <.>
  Try<Clob> tryRead(String name, CommonMimeType mimeType, File file, Charset charset)     // <.>
  Try<Clob> tryReadUtf8(String name, CommonMimeType mimeType, File file)     // <.>
  CharSequence getChars()     // <.>
  Blob toBlob(Charset charset)     // <.>
  Blob toBlobUtf8()     // <.>
  void writeCharsTo(Writer wr)
  void writeTo(File file, Charset charset)     // <.>
  void writeToUtf8(File file)     // <.>
  String asString()
  boolean equals(Object o)
  int hashCode()
  String toString()
}
----

<.> xref:#of_String_CommonMimeType_CharSequence[of(String, CommonMimeType, CharSequence)]
+
--
Returns a new xref:refguide:applib:index/value/Clob.adoc[Clob] of given _name_ , _mimeType_ and _content_ .
--
<.> xref:#tryRead_String_CommonMimeType_DataSource_Charset[tryRead(String, CommonMimeType, DataSource, Charset)]
+
--
Returns a new xref:refguide:applib:index/value/Clob.adoc[Clob] of given _name_ , _mimeType_ and content from _dataSource_ , wrapped with a xref:refguide:commons:index/functional/Try.adoc[Try] .
--
<.> xref:#tryRead_String_CommonMimeType_File_Charset[tryRead(String, CommonMimeType, File, Charset)]
+
--
Shortcut for _tryRead(name, mimeType, DataSource.ofFile(file), charset)_
--
<.> xref:#tryReadUtf8_String_CommonMimeType_File[tryReadUtf8(String, CommonMimeType, File)]
+
--
Shortcut for _#tryRead(String, org.apache.causeway.applib.value.NamedWithMimeType.CommonMimeType, File, Charset)_ using _StandardCharsets#UTF_8_ .
--
<.> xref:#getChars_[getChars()]
+
--
[WARNING]
====
[red]#_deprecated:_#

use _#chars()_ instead
====
--
<.> xref:#toBlob_Charset[toBlob(Charset)]
+
--
Converts to a xref:refguide:applib:index/value/Blob.adoc[Blob] , using given _Charset_ for the underlying String to byte[] conversion.
--
<.> xref:#toBlobUtf8_[toBlobUtf8()]
+
--
Shortcut for _#toBlob(Charset)_ using _StandardCharsets#UTF_8_ .
--
<.> xref:#writeTo_File_Charset[writeTo(File, Charset)]
+
--
Writes this xref:refguide:applib:index/value/Clob.adoc[Clob] to the file represented by the specified `File` object.
--
<.> xref:#writeToUtf8_File[writeToUtf8(File)]
+
--
Shortcut for _#writeTo(File, Charset)_ using _StandardCharsets#UTF_8_ .
--

== Members

[#of_String_CommonMimeType_CharSequence]
=== of(String, CommonMimeType, CharSequence)

Returns a new xref:refguide:applib:index/value/Clob.adoc[Clob] of given _name_ , _mimeType_ and _content_ .

_name_ may or may not include the desired filename extension, as it is guaranteed, that the resulting xref:refguide:applib:index/value/Clob.adoc[Clob] has the appropriate extension as constraint by the given _mimeType_ .

For more fine-grained control use one of the xref:refguide:applib:index/value/Clob.adoc[Clob] constructors directly.

[#tryRead_String_CommonMimeType_DataSource_Charset]
=== tryRead(String, CommonMimeType, DataSource, Charset)

Returns a new xref:refguide:applib:index/value/Clob.adoc[Clob] of given _name_ , _mimeType_ and content from _dataSource_ , wrapped with a xref:refguide:commons:index/functional/Try.adoc[Try] .

_name_ may or may not include the desired filename extension, as it is guaranteed, that the resulting xref:refguide:applib:index/value/Clob.adoc[Clob] has the appropriate extension as constraint by the given _mimeType_ .

For more fine-grained control use one of the xref:refguide:applib:index/value/Clob.adoc[Clob] constructors directly.

[#tryRead_String_CommonMimeType_File_Charset]
=== tryRead(String, CommonMimeType, File, Charset)

Shortcut for _tryRead(name, mimeType, DataSource.ofFile(file), charset)_

[#tryReadUtf8_String_CommonMimeType_File]
=== tryReadUtf8(String, CommonMimeType, File)

Shortcut for _#tryRead(String, org.apache.causeway.applib.value.NamedWithMimeType.CommonMimeType, File, Charset)_ using _StandardCharsets#UTF_8_ .

[#getChars_]
=== getChars()

[WARNING]
====
[red]#_deprecated:_#

use _#chars()_ instead
====

[#toBlob_Charset]
=== toBlob(Charset)

Converts to a xref:refguide:applib:index/value/Blob.adoc[Blob] , using given _Charset_ for the underlying String to byte[] conversion.

[#toBlobUtf8_]
=== toBlobUtf8()

Shortcut for _#toBlob(Charset)_ using _StandardCharsets#UTF_8_ .

[#writeTo_File_Charset]
=== writeTo(File, Charset)

Writes this xref:refguide:applib:index/value/Clob.adoc[Clob] to the file represented by the specified `File` object.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a `FileNotFoundException` is thrown.

[#writeToUtf8_File]
=== writeToUtf8(File)

Shortcut for _#writeTo(File, Charset)_ using _StandardCharsets#UTF_8_ .

include::hooks/Clob_usage-notes.adoc[]
