RuntimeMessage.java
// SECTION-START[License Header]
// <editor-fold defaultstate="collapsed" desc=" Generated License ">
/*
* Java Object Management and Configuration
* Copyright (C) Christian Schulte <cs@schulte.it>, 2011-313
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $JOMC: RuntimeMessage.java 5061 2015-05-31 13:20:40Z schulte $
*
*/
// </editor-fold>
// SECTION-END
package org.jomc.ri.model;
import java.text.MessageFormat;
import java.util.Locale;
import java.util.Map;
import javax.xml.bind.annotation.XmlTransient;
import org.jomc.model.Message;
import org.jomc.model.ModelObjectException;
import static org.jomc.ri.model.RuntimeModelObjects.createMap;
// SECTION-START[Documentation]
// <editor-fold defaultstate="collapsed" desc=" Generated Documentation ">
/**
* Runtime {@code Message}.
*
* <dl>
* <dt><b>Identifier:</b></dt><dd>org.jomc.ri.model.RuntimeMessage</dd>
* <dt><b>Name:</b></dt><dd>JOMC ⁑ RI ⁑ RuntimeMessage</dd>
* <dt><b>Specifications:</b></dt>
* <dd>org.jomc.ri.model.RuntimeModelObject @ 1.2</dd>
* <dt><b>Abstract:</b></dt><dd>No</dd>
* <dt><b>Final:</b></dt><dd>No</dd>
* <dt><b>Stateless:</b></dt><dd>No</dd>
* </dl>
*
* @author <a href="mailto:cs@schulte.it">Christian Schulte</a> 1.2
* @version 1.2
*/
// </editor-fold>
// SECTION-END
// SECTION-START[Annotations]
// <editor-fold defaultstate="collapsed" desc=" Generated Annotations ">
@javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.9", comments = "See http://www.jomc.org/jomc/1.9/jomc-tools-1.9" )
// </editor-fold>
// SECTION-END
public class RuntimeMessage extends Message implements RuntimeModelObject
{
// SECTION-START[RuntimeMessage]
/**
* Java messages by locale cache.
*/
@XmlTransient
private final Map<Locale, MessageFormat> javaMessagesByLocaleCache = createMap();
/**
* Creates a new {@code RuntimeMessage} instance by deeply copying a given {@code Message} instance.
*
* @param message The instance to copy.
*
* @throws NullPointerException if {@code message} is {@code null}.
*/
public RuntimeMessage( final Message message )
{
super( message );
if ( this.getArguments() != null )
{
this.setArguments( RuntimeModelObjects.getInstance().copyOf( this.getArguments() ) );
}
if ( this.getAuthors() != null )
{
this.setAuthors( RuntimeModelObjects.getInstance().copyOf( this.getAuthors() ) );
}
if ( this.getDocumentation() != null )
{
this.setDocumentation( RuntimeModelObjects.getInstance().copyOf( this.getDocumentation() ) );
}
if ( this.getTemplate() != null )
{
this.setTemplate( RuntimeModelObjects.getInstance().copyOf( this.getTemplate() ) );
}
}
/**
* Gets a Java {@code MessageFormat} instance for a given locale.
* <p>
* This method queries an internal cache for a result object to return for the given argument values. If no
* cached result object is available, this method queries the super-class for a result object to return and caches
* the outcome of that query for use on successive calls.
* </p>
* <p>
* <b>Note:</b><br/>Method {@code clear()} must be used to synchronize the state of the internal cache with the
* state of the instance, should the state of the instance change.
* </p>
*
* @param locale The locale to get a Java {@code MessageFormat} instance for.
*
* @return A Java {@code MessageFormat} instance for {@code locale}.
*
* @throws NullPointerException if {@code locale} is {@code null}.
* @throws ModelObjectException if compiling the template of the message for {@code locale} to a
* {@code MessageFormat} fails.
*
* @see #getTemplate()
* @see #clear()
*/
@Override
public MessageFormat getJavaMessage( final Locale locale ) throws ModelObjectException
{
if ( locale == null )
{
throw new NullPointerException( "locale" );
}
synchronized ( this.javaMessagesByLocaleCache )
{
MessageFormat javaMessage = this.javaMessagesByLocaleCache.get( locale );
if ( javaMessage == null && !this.javaMessagesByLocaleCache.containsKey( locale ) )
{
javaMessage = super.getJavaMessage( locale );
this.javaMessagesByLocaleCache.put( locale, javaMessage );
}
return javaMessage;
}
}
// SECTION-END
// SECTION-START[RuntimeModelObject]
public void gc()
{
this.gcOrClear( true, false );
}
public void clear()
{
synchronized ( this.javaMessagesByLocaleCache )
{
this.javaMessagesByLocaleCache.clear();
}
this.gcOrClear( false, true );
}
private void gcOrClear( final boolean gc, final boolean clear )
{
if ( this.getArguments() instanceof RuntimeModelObject )
{
if ( gc )
{
( (RuntimeModelObject) this.getArguments() ).gc();
}
if ( clear )
{
( (RuntimeModelObject) this.getArguments() ).clear();
}
}
if ( this.getAuthors() instanceof RuntimeModelObject )
{
if ( gc )
{
( (RuntimeModelObject) this.getAuthors() ).gc();
}
if ( clear )
{
( (RuntimeModelObject) this.getAuthors() ).clear();
}
}
if ( this.getDocumentation() instanceof RuntimeModelObject )
{
if ( gc )
{
( (RuntimeModelObject) this.getDocumentation() ).gc();
}
if ( clear )
{
( (RuntimeModelObject) this.getDocumentation() ).clear();
}
}
if ( this.getTemplate() instanceof RuntimeModelObject )
{
if ( gc )
{
( (RuntimeModelObject) this.getTemplate() ).gc();
}
if ( clear )
{
( (RuntimeModelObject) this.getTemplate() ).clear();
}
}
}
// SECTION-END
// SECTION-START[Constructors]
// <editor-fold defaultstate="collapsed" desc=" Generated Constructors ">
/** Creates a new {@code RuntimeMessage} instance. */
@javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.9", comments = "See http://www.jomc.org/jomc/1.9/jomc-tools-1.9" )
public RuntimeMessage()
{
// SECTION-START[Default Constructor]
super();
// SECTION-END
}
// </editor-fold>
// SECTION-END
// SECTION-START[Dependencies]
// SECTION-END
// SECTION-START[Properties]
// SECTION-END
// SECTION-START[Messages]
// SECTION-END
}