KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > repo > version > common > VersionUtil


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */

17 package org.alfresco.repo.version.common;
18
19 import java.util.Collection JavaDoc;
20
21 import org.alfresco.repo.version.VersionModel;
22 import org.alfresco.service.cmr.version.ReservedVersionNameException;
23
24 /**
25  * Helper class containing helper methods for the versioning services.
26  *
27  * @author Roy Wetherall
28  */

29 public class VersionUtil
30 {
31     /**
32      * Reserved property names
33      */

34     public static final String JavaDoc[] RESERVED_PROPERTY_NAMES = new String JavaDoc[]{
35         VersionModel.PROP_CREATED_DATE,
36         VersionModel.PROP_FROZEN_NODE_ID,
37         VersionModel.PROP_FROZEN_NODE_STORE_ID,
38         VersionModel.PROP_FROZEN_NODE_STORE_PROTOCOL,
39         VersionModel.PROP_FROZEN_NODE_TYPE,
40         VersionModel.PROP_FROZEN_ASPECTS,
41         VersionModel.PROP_VERSION_LABEL,
42         VersionModel.PROP_VERSION_NUMBER};
43     
44     /**
45      * Checks that the names of the additional version properties are valid and that they do not clash
46      * with the reserved properties.
47      *
48      * @param versionProperties the property names
49      * @return true is the names are considered valid, false otherwise
50      * @throws ReservedVersionNameException
51      */

52     public static void checkVersionPropertyNames(Collection JavaDoc<String JavaDoc> names)
53         throws ReservedVersionNameException
54     {
55         for (String JavaDoc name : RESERVED_PROPERTY_NAMES)
56         {
57             if (names.contains(name) == true)
58             {
59                 throw new ReservedVersionNameException(name);
60             }
61         }
62     }
63 }
64
Popular Tags