Find Usages Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Licensed to the Apache Software Foundation (ASF) under one or more
3
   * contributor license agreements.  See the NOTICE file distributed with
4
   * this work for additional information regarding copyright ownership.
5
   * The ASF licenses this file to You under the Apache License, Version 2.0
6
   * (the "License"); you may not use this file except in compliance with
7
   * the License.  You may obtain a copy of the License at
8
   *
9
   *      http://www.apache.org/licenses/LICENSE-2.0
10
  *
11
  * Unless required by applicable law or agreed to in writing, software
12
  * distributed under the License is distributed on an "AS IS" BASIS,
13
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
  * See the License for the specific language governing permissions and
15
  * limitations under the License.
16
  */
17
 package org.apache.sling.servlets.post.impl.helper;
18
 
20
 import java.util.List;
21
 
22
 import  org.apache.sling.api.request.RequestParameter;
23
 import  org.apache.sling.api.resource.ResourceUtil;
Encapsulates all infos from the respective request parameters that are needed to create the repository property 
29
 
30
 public class RequestProperty {
31
 
32
     private static final RequestParameter[] EMPTY_PARAM_ARRAY = new RequestParameter[0];
33
 
34
     public static final String DEFAULT_IGNORE = .
35
         + "ignore";
36
 
37
     public static final String DEFAULT_NULL = .
38
         + "null";
39
 
40
     private final String path;
41
 
42
     private final String name;
43
 
44
     private final String parentPath;
45
 
46
     private RequestParameter[] values;
47
 
48
     private String[] stringValues;
49
 
50
     private String typeHint;
51
 
52
     private boolean hasMultiValueTypeHint;
53
 
54
     private RequestParameter[] defaultValues = ;
55
 
56
     private boolean isDelete;
57
 
58
     private String repositoryResourcePath;
59
 
60
     private boolean isRepositoryResourceMove;
61
 
62
     private boolean ignoreBlanks;
63
 
64
     private boolean useDefaultWhenMissing;
65
 
66
     public RequestProperty(String path) {
67
         assert path.startsWith("/");
68
         this.path = ResourceUtil.normalize(path);
69
         this.parentPath = ResourceUtil.getParent(path);
70
         this.name = ResourceUtil.getName(path);
71
     }
72
 
73
     public String getTypeHint() {
74
         return typeHint;
75
     }
76
 
77
     public boolean hasMultiValueTypeHint() {
78
         return this.hasMultiValueTypeHint;
79
     }
80
 
81
     public void setTypeHintValue(String typeHint) {
82
         if ( typeHint != null && typeHint.endsWith("[]") ) {
83
             this.typeHint = typeHint.substring(0, typeHint.length() - 2);
84
             this.hasMultiValueTypeHint = true;
85
         } else {
86
             this.typeHint = typeHint;
87
             this.hasMultiValueTypeHint = false;
88
         }
89
     }
90
 
91
     public String getPath() {
92
         return path;
93
     }
94
 
95
     public String getName() {
96
         return name;
97
     }
98
 
99
     public String getParentPath() {
100
        return parentPath;
101
    }
103
    public boolean hasValues() {
104
        if (useDefaultWhenMissing && defaultValues != null && defaultValues.length > 0) {
105
            return true;
106
        } else {
107
            if (ignoreBlanks) {
108
                return (values != null && getStringValues().length > 0);
109
            } else {
110
                return values != null;
111
            }
112
        }
113
    }
115
    public RequestParameter[] getValues() {
116
        return values;
117
    }
119
    public void setValues(RequestParameter[] values) {
120
        this.values = values;
121
    }
123
    public RequestParameter[] getDefaultValues() {
124
        return defaultValues;
125
    }
127
    public void setDefaultValues(RequestParameter[] defaultValues) {
128
        if (defaultValues == null) {
129
            this.defaultValues = EMPTY_PARAM_ARRAY;
130
        } else {
131
            this.defaultValues = defaultValues;
132
        }
133
    }
135
    public boolean isFileUpload() {
136
        return values != null && !values[0].isFormField();
137
    }

    
Checks if this property provides any values. this is the case if one of the values is not empty or if the default handling is not 'ignore'

Returns:
true if this property provides values
145
    public boolean providesValue() {
146
        // should void double creation of string values
147
        String[] sv = getStringValues();
148
        if (sv == null) {
149
            // is missleading return type. but means that property should not
150
            // get auto-create values
151
            return true;
152
        }
153
        for (String s : sv) {
154
            if (!s.equals("")) {
155
                return true;
156
            }
157
        }
158
        return false;
159
    }

    
Returns the assembled string array out of the provided request values and default values.

Returns:
a String array or null if the property needs to be removed.
168
    public String[] getStringValues() {
169
        if (stringValues == null) {
170
            if (values == null && useDefaultWhenMissing) {
171
                stringValues = new String[] { defaultValues[0].getString() };
172
            } else if (values.length > 1) {
173
                // TODO: how the default values work for MV props is not very
174
                // clear
175
                List<String> stringValueList = new ArrayList<String>(values.length);
176
                for (int i = 0; i < values.length; i++) {
177
                    String value = values[i].getString();
178
                    if ((!ignoreBlanks) || value.length() > 0) {
179
                        stringValueList.add(value);
180
                    }
181
                }
182
                stringValues = stringValueList.toArray(new String[stringValueList.size()]);
183
            } else {
184
                String value = values[0].getString();
185
                if (value.equals("")) {
186
                    if (ignoreBlanks) {
187
                        return new String[0];
188
                    } else {
189
                        if (defaultValues.length == 1) {
190
                            String defValue = defaultValues[0].getString();
191
                            if (defValue.equals(DEFAULT_IGNORE)) {
192
                                // ignore means, do not create empty values
193
                                return new String[0];
194
                            } else if (defValue.equals(DEFAULT_NULL)) {
195
                                // null means, remove property if exist
196
                                return null;
197
                            }
198
                            value = defValue;
199
                        }
200
                    }
201
                }
202
                stringValues = new String[] { value };
203
            }
204
        }
205
        return stringValues;
206
    }

    
Specifies whether this property should be deleted before any new content is to be set according to the values stored.

Parameters:
isDelete true if the repository item described by this is to be deleted before any other operation.
215
    public void setDelete(boolean isDelete) {
216
        this.isDelete = isDelete;
217
    }

    
Returns true if the repository item described by this is to be deleted before setting new content to it. 
223
    public boolean isDelete() {
224
        return isDelete;
225
    }

    
Sets the path of the repository item from which the content for this property is to be copied or moved. The path may be relative in which case it will be resolved relative to the absolute path of this property.

Parameters:
sourcePath The path of the repository item to get the content from
isMove true if the source content is to be moved, otherwise the source content is copied from the repository item.
237
    public void setRepositorySource(String sourcePath, boolean isMove) {
239
        // make source path absolute
240
        if (!sourcePath.startsWith("/")) {
241
            sourcePath = getParentPath() + "/" + sourcePath;
242
            sourcePath = ResourceUtil.normalize(sourcePath);
243
        }
245
        this.repositoryResourcePath = sourcePath;
246
        this.isRepositoryResourceMove = isMove;
247
    }

    
Returns true if the content of this property is to be set by moving content from another repository item.

See also:
getRepositorySource()
255
    public boolean hasRepositoryMoveSource() {
256
        return isRepositoryResourceMove;
257
    }

    
Returns true if the content of this property is to be set by copying content from another repository item.

See also:
getRepositorySource()
265
    public boolean hasRepositoryCopySource() {
266
        return getRepositorySource() != null && !hasRepositoryMoveSource();
267
    }

    
Returns the absolute path of the repository item from which the content for this property is to be copied or moved.

See also:
hasRepositoryCopySource()
hasRepositoryMoveSource()
setRepositorySource(String, boolean)
277
    public String getRepositorySource() {
278
        return repositoryResourcePath;
279
    }
281
    public void setIgnoreBlanks(boolean b) {
282
        ignoreBlanks = b;
283
    }
285
    public void setUseDefaultWhenMissing(boolean b) {
286
        useDefaultWhenMissing = b;
287
    }
New to GrepCode? Check out our FAQ X