1 /*
2  * Copyright (C) 2012 The Android Open Source Project
3  *
4  * Licensed under the Eclipse Public License, Version 1.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.eclipse.org/org/documents/epl-v10.php
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.android.ide.eclipse.adt.internal.wizards.templates;
17 
18 import com.android.ide.common.res2.ValueXmlHelper;
19 
20 import freemarker.template.SimpleScalar;
21 import freemarker.template.TemplateMethodModel;
22 import freemarker.template.TemplateModel;
23 import freemarker.template.TemplateModelException;
24 
25 import java.util.List;
26 
27 /**
28  * Method invoked by FreeMarker to escape a string such that it can be placed
29  * as text in a string resource file.
30  * This is similar to {@link FmEscapeXmlTextMethod}, but in addition to escaping
31  * < and & it also escapes characters such as quotes necessary for Android
32  *{@code <string>} elements.
33  */
34 public class FmEscapeXmlStringMethod implements TemplateMethodModel {
35     @Override
exec(List args)36     public TemplateModel exec(List args) throws TemplateModelException {
37         if (args.size() != 1) {
38             throw new TemplateModelException("Wrong arguments");
39         }
40         String string = args.get(0).toString();
41         return new SimpleScalar(ValueXmlHelper.escapeResourceString(string));
42     }
43 }