PrefixMap (Apache Jena ARQ)

All Known Implementing Classes:

PrefixMapBase, PrefixMapExtended, PrefixMapNull, PrefixMapStd, PrefixMapUnmodifiable, PrefixMapWrapper
```
public interface PrefixMap
```
Interface for lightweight prefix maps, this is similar to PrefixMapping from Jena Core but it omits any reverse lookup functionality.
The contract also does not require an implementation to do any validation unlike the Jena Core PrefixMapping which requires validation of prefixes.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`org.apache.jena.atlas.lib.Pair<String,String>`	`abbrev(String uriStr)` Abbreviate an IRI and return a pair of prefix and local parts, or null.
`String`	`abbreviate(String uriStr)` Abbreviate an IRI or return null
`default void`	`add(String prefix, org.apache.jena.iri.IRI iri)` Deprecated. Use `add(String, String)`
`void`	`add(String prefix, String iriString)` Add a prefix, overwrites any existing association
`void`	`clear()` Clear all prefixes.
`default boolean`	`contains(String prefix)` Deprecated. Use `containsPrefix(String)`
`boolean`	`containsPrefix(String prefix)` Gets whether the map contains a given prefix
`void`	`delete(String prefix)` Delete a prefix
`String`	`expand(String prefixedName)` Expand a prefix named, return null if it can't be expanded
`String`	`expand(String prefix, String localName)` Expand a prefix, return null if it can't be expanded
`void`	`forEach(BiConsumer<String,String> action)` Apply a `BiConsumer<String, String>` to each entry in the Prefixmap.
`Map<String,String>`	`getMapping()` Return the underlying mapping, this is generally unsafe to modify and implementations may opt to return an unmodifiable view of the mapping if they wish.
`Map<String,String>`	`getMappingCopy()` Return a fresh copy of the underlying mapping, should be safe to modify unlike the mapping returned from `getMapping()`
`boolean`	`isEmpty()` Return whether the prefix map is empty or not.
`void`	`putAll(Map<String,String> mapping)` Add a prefix, overwrites any existing association
`void`	`putAll(PrefixMap pmap)` Add a prefix, overwrites any existing association
`void`	`putAll(PrefixMapping pmap)` Add a prefix, overwrites any existing association
`int`	`size()` Return the number of entries in the prefix map.

- Method Detail
  - getMapping
```
Map<String,String> getMapping()
```
    Return the underlying mapping, this is generally unsafe to modify and implementations may opt to return an unmodifiable view of the mapping if they wish.
    
    Returns:
    
    Underlying mapping
    
    See Also:
    
    getMappingCopy()
  - getMappingCopy
```
Map<String,String> getMappingCopy()
```
    Return a fresh copy of the underlying mapping, should be safe to modify unlike the mapping returned from getMapping()
    
    Returns:
    
    Copy of the mapping
  - forEach
```
void forEach(BiConsumer<String,String> action)
```
    Apply a BiConsumer<String, String> to each entry in the Prefixmap.
  - add
```
void add(String prefix,
         String iriString)
```
    Add a prefix, overwrites any existing association
    
    Parameters:
    
    prefix - Prefix
    
    iriString - Namespace IRI
  - add
```
@Deprecated
default void add(String prefix,
                             org.apache.jena.iri.IRI iri)
```
    Deprecated. Use add(String, String)
    
    Add a prefix, overwrites any existing association
    
    Parameters:
    
    prefix - Prefix
    
    iri - Namespace IRI
  - putAll
```
void putAll(PrefixMap pmap)
```
    Add a prefix, overwrites any existing association
    
    Parameters:
    
    pmap - Prefix Map
  - putAll
```
void putAll(PrefixMapping pmap)
```
    Add a prefix, overwrites any existing association
    
    Parameters:
    
    pmap - Prefix Mapping
  - putAll
```
void putAll(Map<String,String> mapping)
```
    Add a prefix, overwrites any existing association
    
    Parameters:
    
    mapping - A Map of prefix name to IRI string
  - delete
```
void delete(String prefix)
```
    Delete a prefix
    
    Parameters:
    
    prefix - Prefix to delete
  - clear
```
void clear()
```
    Clear all prefixes.
  - containsPrefix
```
boolean containsPrefix(String prefix)
```
    Gets whether the map contains a given prefix
    
    Parameters:
    
    prefix - Prefix
    
    Returns:
    
    True if the prefix is contained in the map, false otherwise
  - contains
```
@Deprecated
default boolean contains(String prefix)
```
    Deprecated. Use containsPrefix(String)
  - abbreviate
```
String abbreviate(String uriStr)
```
    Abbreviate an IRI or return null
    
    Parameters:
    
    uriStr - URI to abbreviate
    
    Returns:
    
    URI in prefixed name form if possible, null otherwise
  - abbrev
```
org.apache.jena.atlas.lib.Pair<String,String> abbrev(String uriStr)
```
    Abbreviate an IRI and return a pair of prefix and local parts, or null.
    
    Parameters:
    
    uriStr - URI string to abbreviate
    
    Returns:
    
    Pair of prefix and local name
    
    See Also:
    
    abbreviate(java.lang.String)
  - expand
```
String expand(String prefixedName)
```
    Expand a prefix named, return null if it can't be expanded
    
    Parameters:
    
    prefixedName - Prefixed Name
    
    Returns:
    
    Expanded URI if possible, null otherwise
  - expand
```
String expand(String prefix,
              String localName)
```
    Expand a prefix, return null if it can't be expanded
    
    Parameters:
    
    prefix - Prefix
    
    localName - Local name
    
    Returns:
    
    Expanded URI if possible, null otherwise
  - isEmpty
```
boolean isEmpty()
```
    Return whether the prefix map is empty or not.
  - size
```
int size()
```
    Return the number of entries in the prefix map.

Interface PrefixMap

Method Summary

Method Detail

getMapping

getMappingCopy

forEach

add

add

putAll

putAll

putAll

delete

clear

containsPrefix

contains

abbreviate

abbrev

expand

expand

isEmpty

size