1 // SECTION-START[License Header] 2 // <editor-fold defaultstate="collapsed" desc=" Generated License "> 3 /* 4 * Java Object Management and Configuration 5 * Copyright (C) Christian Schulte <cs@schulte.it>, 2011-313 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * o Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * o Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 21 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 22 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 * 31 * $JOMC: RuntimeDependencies.java 5061 2015-05-31 13:20:40Z schulte $ 32 * 33 */ 34 // </editor-fold> 35 // SECTION-END 36 package org.jomc.ri.model; 37 38 import java.util.Map; 39 import javax.xml.bind.annotation.XmlTransient; 40 import org.jomc.model.Dependencies; 41 import org.jomc.model.Dependency; 42 import static org.jomc.ri.model.RuntimeModelObjects.createMap; 43 44 // SECTION-START[Documentation] 45 // <editor-fold defaultstate="collapsed" desc=" Generated Documentation "> 46 /** 47 * Runtime {@code Dependencies}. 48 * 49 * <dl> 50 * <dt><b>Identifier:</b></dt><dd>org.jomc.ri.model.RuntimeDependencies</dd> 51 * <dt><b>Name:</b></dt><dd>JOMC ⁑ RI ⁑ RuntimeDependencies</dd> 52 * <dt><b>Specifications:</b></dt> 53 * <dd>org.jomc.ri.model.RuntimeModelObject @ 1.2</dd> 54 * <dt><b>Abstract:</b></dt><dd>No</dd> 55 * <dt><b>Final:</b></dt><dd>No</dd> 56 * <dt><b>Stateless:</b></dt><dd>No</dd> 57 * </dl> 58 * 59 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a> 1.2 60 * @version 1.2 61 */ 62 // </editor-fold> 63 // SECTION-END 64 // SECTION-START[Annotations] 65 // <editor-fold defaultstate="collapsed" desc=" Generated Annotations "> 66 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.9", comments = "See http://www.jomc.org/jomc/1.9/jomc-tools-1.9" ) 67 // </editor-fold> 68 // SECTION-END 69 public class RuntimeDependencies extends Dependencies implements RuntimeModelObject 70 { 71 // SECTION-START[RuntimeDependencies] 72 73 /** 74 * Cache map. 75 */ 76 @XmlTransient 77 private transient final Map<String, Dependency> dependenciesByNameCache = createMap(); 78 79 /** 80 * Creates a new {@code RuntimeDependencies} instance by deeply copying a given {@code Dependencies} instance. 81 * 82 * @param dependencies The instance to copy. 83 * 84 * @throws NullPointerException if {@code dependencies} is {@code null}. 85 */ 86 public RuntimeDependencies( final Dependencies dependencies ) 87 { 88 super( dependencies ); 89 90 if ( this.getAuthors() != null ) 91 { 92 this.setAuthors( RuntimeModelObjects.getInstance().copyOf( this.getAuthors() ) ); 93 } 94 if ( this.getDocumentation() != null ) 95 { 96 this.setDocumentation( RuntimeModelObjects.getInstance().copyOf( this.getDocumentation() ) ); 97 } 98 99 this.copyDependencies(); 100 } 101 102 /** 103 * Gets a dependency for a given name from the list of dependencies. 104 * <p> 105 * This method queries an internal cache for a result object to return for the given argument values. If no 106 * cached result object is available, this method queries the super-class for a result object to return and caches 107 * the outcome of that query for use on successive calls. 108 * </p> 109 * <p> 110 * <b>Note:</b><br/>Method {@code clear()} must be used to synchronize the state of the internal cache with the 111 * state of the instance, should the state of the instance change. 112 * </p> 113 * 114 * @param name The name of the dependency to return. 115 * 116 * @return The first matching dependency or {@code null}, if no such dependency is found. 117 * 118 * @throws NullPointerException if {@code name} is {@code null}. 119 * 120 * @see #getDependency() 121 * @see Dependency#getName() 122 * @see #clear() 123 */ 124 @Override 125 public Dependency getDependency( final String name ) 126 { 127 if ( name == null ) 128 { 129 throw new NullPointerException( "identifier" ); 130 } 131 132 synchronized ( this.dependenciesByNameCache ) 133 { 134 Dependency d = this.dependenciesByNameCache.get( name ); 135 136 if ( d == null && !this.dependenciesByNameCache.containsKey( name ) ) 137 { 138 d = super.getDependency( name ); 139 this.dependenciesByNameCache.put( name, d ); 140 } 141 142 return d; 143 } 144 } 145 146 private void copyDependencies() 147 { 148 for ( int i = 0, s0 = this.getDependency().size(); i < s0; i++ ) 149 { 150 final Dependency d = this.getDependency().get( i ); 151 this.getDependency().set( i, RuntimeModelObjects.getInstance().copyOf( d ) ); 152 } 153 } 154 155 // SECTION-END 156 // SECTION-START[RuntimeModelObject] 157 public void gc() 158 { 159 this.gcOrClear( true, false ); 160 } 161 162 public void clear() 163 { 164 synchronized ( this.dependenciesByNameCache ) 165 { 166 this.dependenciesByNameCache.clear(); 167 } 168 169 this.gcOrClear( false, true ); 170 } 171 172 private void gcOrClear( final boolean gc, final boolean clear ) 173 { 174 if ( this.getAuthors() instanceof RuntimeModelObject ) 175 { 176 if ( gc ) 177 { 178 ( (RuntimeModelObject) this.getAuthors() ).gc(); 179 } 180 if ( clear ) 181 { 182 ( (RuntimeModelObject) this.getAuthors() ).clear(); 183 } 184 } 185 if ( this.getDocumentation() instanceof RuntimeModelObject ) 186 { 187 if ( gc ) 188 { 189 ( (RuntimeModelObject) this.getDocumentation() ).gc(); 190 } 191 if ( clear ) 192 { 193 ( (RuntimeModelObject) this.getDocumentation() ).clear(); 194 } 195 } 196 197 this.gcOrClearDependencies( gc, clear ); 198 } 199 200 private void gcOrClearDependencies( final boolean gc, final boolean clear ) 201 { 202 203 for ( int i = 0, s0 = this.getDependency().size(); i < s0; i++ ) 204 { 205 final Dependency d = this.getDependency().get( i ); 206 if ( d instanceof RuntimeModelObject ) 207 { 208 if ( gc ) 209 { 210 ( (RuntimeModelObject) d ).gc(); 211 } 212 if ( clear ) 213 { 214 ( (RuntimeModelObject) d ).clear(); 215 } 216 } 217 } 218 } 219 220 // SECTION-END 221 // SECTION-START[Constructors] 222 // <editor-fold defaultstate="collapsed" desc=" Generated Constructors "> 223 /** Creates a new {@code RuntimeDependencies} instance. */ 224 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.9", comments = "See http://www.jomc.org/jomc/1.9/jomc-tools-1.9" ) 225 public RuntimeDependencies() 226 { 227 // SECTION-START[Default Constructor] 228 super(); 229 // SECTION-END 230 } 231 // </editor-fold> 232 // SECTION-END 233 // SECTION-START[Dependencies] 234 // SECTION-END 235 // SECTION-START[Properties] 236 // SECTION-END 237 // SECTION-START[Messages] 238 // SECTION-END 239 240 }