PerforceCharsets (p4java 2023.2.2581742 API)

java.lang.Object
- com.perforce.p4java.server.PerforceCharsets

```
public class PerforceCharsets
extends java.lang.Object
```
Encapsulates Perforce-wide charset information for servers.
Unfortunately, support for Unicode and associated charsets is somewhat server- and installation-dependent, and not easy to divine unless you're already talking to a Perforce server -- by which time it's too late. This class is an attempt to make it easier to cut that Gordian knot...
Note that the names below are not actually the standard name for the charset in some cases: e.g. UTF-8 should be "utf-8" not "utf8", but we follow the Perforce server's rules here.
The following are special cases.
```
 "auto" (Guess a P4CHARSET based on client OS params)
 "none" (same as unsetting P4CHARSET)
 
```

Constructor Summary

Constructors
Constructor and Description

PerforceCharsets()

Constructors
Constructor and Description
`PerforceCharsets()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getJavaCharsetName(java.lang.String p4CharsetName)` Get Java equivalent charset name for a p4 charset name
`static java.lang.String[]`	`getKnownCharsets()` Get known P4 charsets
`static java.nio.charset.Charset`	`getP4Charset(java.lang.String p4CharsetName)` Get the matching Java charset for a given P4 charset name.
`static java.lang.String`	`getP4CharsetName(java.lang.String javaCharsetName)` Get the first matching Perforce equivalent charset name for a given Java charset name.
`static boolean`	`hasClientBOM(java.lang.String p4CharsetName)`
`static boolean`	`isSupported(java.lang.String p4CharsetName)` Is the P4 charset name specified supported?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PerforceCharsets
```
public PerforceCharsets()
```
- Method Detail
  - getKnownCharsets
```
public static java.lang.String[] getKnownCharsets()
```
    Get known P4 charsets
    
    Returns:
    
    - array of p4 charset names
  - getP4CharsetName
```
public static java.lang.String getP4CharsetName(java.lang.String javaCharsetName)
```
    Get the first matching Perforce equivalent charset name for a given Java charset name. Multiple Perforce charsets can be mapped to a Java charset (i.e. Perforce "utf8-bom" and "utf8unchecked" are mapped to Java "UTF-8")
    
    Parameters:
    
    javaCharsetName - charset
    
    Returns:
    
    - Perforce charset name
  - getP4Charset
```
public static java.nio.charset.Charset getP4Charset(java.lang.String p4CharsetName)
```
    Get the matching Java charset for a given P4 charset name.
    
    Parameters:
    
    p4CharsetName - charset
    
    Returns:
    
    - Java charset
  - getJavaCharsetName
```
public static java.lang.String getJavaCharsetName(java.lang.String p4CharsetName)
```
    Get Java equivalent charset name for a p4 charset name
    
    Parameters:
    
    p4CharsetName - charset
    
    Returns:
    
    - Java charset name
  - hasClientBOM
```
public static boolean hasClientBOM(java.lang.String p4CharsetName)
```
    Parameters:
    
    p4CharsetName - charset
    
    Returns:
    
    true, if client charset has BOM
  - isSupported
```
public static boolean isSupported(java.lang.String p4CharsetName)
```
    Is the P4 charset name specified supported?
    
    Parameters:
    
    p4CharsetName - charset
    
    Returns:
    
    - true if supported, false otherwise

Class PerforceCharsets

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PerforceCharsets

Method Detail

getKnownCharsets

getP4CharsetName

getP4Charset

getJavaCharsetName

hasClientBOM

isSupported