Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
MapStage1 |
|
| 1.0;1 |
1 | /* | |
2 | * #%L | |
3 | * MapStage1.java - mongodb-async-driver - Allanbank Consulting, Inc. | |
4 | * %% | |
5 | * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc. | |
6 | * %% | |
7 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
8 | * you may not use this file except in compliance with the License. | |
9 | * You may obtain a copy of the License at | |
10 | * | |
11 | * http://www.apache.org/licenses/LICENSE-2.0 | |
12 | * | |
13 | * Unless required by applicable law or agreed to in writing, software | |
14 | * distributed under the License is distributed on an "AS IS" BASIS, | |
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
16 | * See the License for the specific language governing permissions and | |
17 | * limitations under the License. | |
18 | * #L% | |
19 | */ | |
20 | ||
21 | package com.allanbank.mongodb.builder.expression; | |
22 | ||
23 | /** | |
24 | * MapStage1 provides a container for the {@code $map} input field name before | |
25 | * adding the variable name. | |
26 | * | |
27 | * @api.yes This class is part of the driver's API. Public and protected members | |
28 | * will be deprecated for at least 1 non-bugfix release (version | |
29 | * numbers are <major>.<minor>.<bugfix>) before being | |
30 | * removed or modified. | |
31 | * @copyright 2014, Allanbank Consulting, Inc., All Rights Reserved | |
32 | */ | |
33 | public class MapStage1 { | |
34 | /** The name of the {@code input} field. */ | |
35 | private final String myInputField; | |
36 | ||
37 | /** | |
38 | * Creates a new MapStage2. | |
39 | * | |
40 | * @param inputField | |
41 | * The name of the {@code input} field. | |
42 | */ | |
43 | 1 | /* package */MapStage1(final String inputField) { |
44 | 1 | myInputField = inputField; |
45 | 1 | } |
46 | ||
47 | /** | |
48 | * Sets the variable name to be used in the mapping. | |
49 | * | |
50 | * @param variableName | |
51 | * The name of the variable. | |
52 | * @return The second stage of the {@code $map} construction. | |
53 | */ | |
54 | public MapStage2 as(final String variableName) { | |
55 | 1 | return new MapStage2(myInputField, variableName); |
56 | } | |
57 | } |