Modifier and Type	Class and Description
private static class	ViewMetadataImpl.ConstantsMap Specific map implementation which wraps the given map in `Collections#unmodifiableMap(Map)` and throws an `IllegalArgumentException` in `ConstantsMap#get(Object)` method when the key doesn't exist at all.

Modifier and Type	Field and Description
private DefaultFaceletFactory	faceletFactory
private final String	viewId

Access	Constructor and Description
public	ViewMetadataImpl(String viewId)

Method Summary

Modifier and Type	Method and Description
private static Map<String, Object>	Returns: Constants of the given type. collectConstants(String The fully qualified name of the type to collect constants for. type) Collect constants of the given type.
public UIViewRoot	createMetadataView(FacesContext the `FacesContext` for the current request context) Implements abstract jakarta.faces.view.ViewMetadata.createMetadataView. Creates a new `UIViewRoot` containing only view parameter metadata.
public String	getViewId() Implements abstract jakarta.faces.view.ViewMetadata.getViewId. Get the view id
private static void	importConstantsIfNecessary(FacesContext context, UIViewRoot root)
private static Class<?>	Returns: The concrete `Class` instance. toClass(String The fully qualified name of the class. type) Convert the given type, which should represent a fully qualified name, to a concrete `Class` instance.

Inherited from jakarta.faces.view.ViewMetadata:: getImportConstants getViewActions getViewParameters hasMetadata

Field Detail

faceletFactory	back to summary
private DefaultFaceletFactory faceletFactory

viewId	back to summary
private final String viewId

Method Detail

collectConstants	back to summary
private static Map<String, Object> collectConstants(String type) Collect constants of the given type. That are, all public static final fields of the given type. Parameters type:String The fully qualified name of the type to collect constants for. Returns:Map<String, Object> Constants of the given type.

collectConstants

back to summary

private static Map<String, Object> collectConstants(String type)

Collect constants of the given type. That are, all public static final fields of the given type.

Parameters

type:String: The fully qualified name of the type to collect constants for.

Returns:Map<String, Object>

Constants of the given type.

createMetadataView back to summary

public UIViewRoot createMetadataView(FacesContext context)

Implements abstract jakarta.faces.view.ViewMetadata.createMetadataView.

Doc from jakarta.faces.view.ViewMetadata.createMetadataView.

Creates a new UIViewRoot containing only view parameter metadata. The processing of building this UIViewRoot with metadata should not cause any events to be published to the application. The implementation must call FacesContext#setProcessingEvents passing false as the argument, at the beginning of the method, and pass true to the same method at the end. The implementation must ensure that this happens regardless of ant exceptions that may be thrown.

Take note a compliant implementation has to ensure that:

the new UIViewRoot must be set as the FacesContext's viewRoot before applying the tag handlers, restoring the old FacesContext in a finally block.
The contents of the current UIViewRoot's ViewMap must be copied to the ViewMap of the new UIViewRoot before applying the tag handlers.
The UIImportConstants must be processed after applying the tag handlers.

Parameters

context:FacesContext: the FacesContext for the current request

Returns:UIViewRoot

a UIViewRoot containing only view parameter metadata (if any)

Annotations

@Override

getViewId back to summary

getViewId	back to summary
public String getViewId() Implements abstract jakarta.faces.view.ViewMetadata.getViewId. Doc from jakarta.faces.view.ViewMetadata.getViewId. Get the view id Returns:String the view ID for which this `ViewMetadata` instance was created Annotations @Override See Also `jakarta.faces.view.ViewMetadata#getViewId()`

public String getViewId()

Implements abstract jakarta.faces.view.ViewMetadata.getViewId.

Doc from jakarta.faces.view.ViewMetadata.getViewId.

Get the view id

Returns:String

the view ID for which this ViewMetadata instance was created

Annotations

@Override

importConstantsIfNecessary	back to summary
private static void importConstantsIfNecessary(FacesContext context, UIViewRoot root)

toClass back to summary

toClass	back to summary
private static Class<?> toClass(String type) Convert the given type, which should represent a fully qualified name, to a concrete `Class` instance. Parameters type:String The fully qualified name of the class. Returns:Class<?> The concrete `Class` instance. Exceptions IllegalArgumentException: When it is missing in the classpath.

private static Class<?> toClass(String type)

Convert the given type, which should represent a fully qualified name, to a concrete Class instance.

Parameters

type:String: The fully qualified name of the class.

Returns:Class<?>

The concrete Class instance.

Exceptions

IllegalArgumentException:: When it is missing in the classpath.

com.sun.faces.application.view back to summary

private Class ViewMetadataImpl.ConstantsMap

Class Inheritance

extends HashMap<String, Object>

java.lang.Object
java.util.AbstractMap
java.util.HashMap
com.sun.faces.application.view.ViewMetadataImpl.ConstantsMap

Specific map implementation which wraps the given map in Collections#unmodifiableMap(Map) and throws an IllegalArgumentException in ConstantsMap#get(Object) method when the key doesn't exist at all.

Author: Bauke Scholtz
Since: 2.3

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.util.HashMap.serialVersionUID.
private String	type

Constructor Summary

Access	Constructor and Description
public	ConstantsMap(Map<String, Object> map, String type)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object object to be compared for equality with this map object) Overrides java.util.AbstractMap.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public Object	get(Object the key whose associated value is to be returned key) Overrides java.util.HashMap.get. Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public int	hashCode() Overrides java.util.AbstractMap.hashCode. Implements java.util.Map.hashCode. Returns the hash code value for this map.

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.HashMap.serialVersionUID.

type	back to summary
private String type

Constructor Detail

ConstantsMap	back to summary
public ConstantsMap(Map<String, Object> map, String type)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.util.AbstractMap.equals. Implements java.util.Map.equals. Doc from java.util.Map.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. Parameters object:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to this map Annotations @Override

public boolean equals(Object object)

Overrides java.util.AbstractMap.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters

object:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations

@Override

get back to summary

get	back to summary
public Object get(Object key) Overrides java.util.HashMap.get. Implements java.util.Map.get. Doc from java.util.HashMap.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `(key==null ? k==null : key.equals(k))`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) A return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object Doc from java.util.Map.get. the key whose associated value is to be returned Returns:Object Doc from java.util.Map.get. the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public Object get(Object key)

Overrides java.util.HashMap.get.

Implements java.util.Map.get.

Doc from java.util.HashMap.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object

Doc from java.util.Map.get.

the key whose associated value is to be returned

Returns:Object

Doc from java.util.Map.get.

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.util.AbstractMap.hashCode. Implements java.util.Map.hashCode. Doc from java.util.Map.hashCode. Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's `entrySet()` view. This ensures that `m1.equals(m2)` implies that `m1.hashCode()==m2.hashCode()` for any two maps `m1` and `m2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this map Annotations @Override

public int hashCode()

Overrides java.util.AbstractMap.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.Map.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations

@Override

public Class ViewMetadataImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ViewMetadataImpl.ConstantsMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail