Overview  Package   Class  Use  Deprecated  Index
Home >> All >> ru >> gammalabs >> ice >> publishing >> [ framework overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

ru.gammalabs.ice.publishing.framework
Class Template  

java.lang.Object
  ru.gammalabs.ice.publishing.framework.Template

Direct Known Subclasses:

PageTemplate

---

public class Template

extends java.lang.Object

Class implementing basic template model. It is supposed that each Template has several TemplateStorages, one and only one TemplateStorage for each of the supported Locales.

Version:

1.1

---

Field Summary
protected  java.lang.Long	id           Template id (should not be used in business logic - consider using name instead).
protected  java.lang.String	name           Template name.
protected  java.util.Map	storages           Map containing TemplateStorages of this template.

 

Constructor Summary

Template()           Public constructor.

 

Method Summary
void	addTemplateStorage(java.util.Locale locale, TemplateStorage storage)           Adds a template storage to the template.
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
java.util.Collection	getAllTemplateStorages()           Gets all of the template storages of this template.
java.lang.Long	getId()           Gets template id.
java.util.Collection	getLocales()           Gets all of the locales supported by this template.
java.lang.String	getName()           Gets template name.
TemplateStorage	getTemplateStorage(java.util.Locale locale)           Gets TemplateStorage for the specified locale.
void	removeTemplateStorage(java.util.Locale locale)           Removes a template storage for the specified locale.
void	setId(long id)           Convenience method.
void	setId(java.lang.Long id)           Sets template id.
void	setName(java.lang.String name)           Sets template name.
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

name

protected java.lang.String name

Template name.

---

id

protected java.lang.Long id

Template id (should not be used in business logic - consider using name instead).

---

storages

protected java.util.Map storages

Map containing TemplateStorages of this template. Keys are Locales supported by this template. Values are TemplateStorages of this template.

See Also:

TemplateStorage

Constructor Detail

Template

public Template()

Public constructor.

Method Detail

getName

public java.lang.String getName()

Gets template name.

---

setName

public void setName(java.lang.String name)

Sets template name.

---

getId

public java.lang.Long getId()

Gets template id.

---

setId

public void setId(java.lang.Long id)

Sets template id.

---

setId

public void setId(long id)

Convenience method. Sets template id.

---

getLocales

public java.util.Collection getLocales()

Gets all of the locales supported by this template.

---

getAllTemplateStorages

public java.util.Collection getAllTemplateStorages()

Gets all of the template storages of this template.

---

getTemplateStorage

public TemplateStorage getTemplateStorage(java.util.Locale locale)

Gets TemplateStorage for the specified locale.

---

addTemplateStorage

public void addTemplateStorage(java.util.Locale locale,
                               TemplateStorage storage)

Adds a template storage to the template.

---

removeTemplateStorage

public void removeTemplateStorage(java.util.Locale locale)

Removes a template storage for the specified locale.

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

equals

public boolean equals(java.lang.Object o)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> ru >> gammalabs >> ice >> publishing >> [ framework overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---